1 /***************************************************************************
2 * Copyright (C) 2009 Zachary T Welch *
3 * zw@superlucidity.net *
5 * Copyright (C) 2007,2008,2009 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2005 by Dominic Rath *
13 * Dominic.Rath@gmx.de *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program; if not, write to the *
27 * Free Software Foundation, Inc., *
28 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
29 ***************************************************************************/
35 #include "minidriver.h"
36 #include "interface.h"
43 /// The number of JTAG queue flushes (for profiling and debugging purposes).
44 static int jtag_flush_queue_count;
46 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
47 int in_num_fields, scan_field_t *in_fields, tap_state_t state);
50 * The jtag_error variable is set when an error occurs while executing
51 * the queue. Application code may set this using jtag_set_error(),
52 * when an error occurs during processing that should be reported during
53 * jtag_execute_queue().
55 * Tts value may be checked with jtag_get_error() and cleared with
56 * jtag_error_clear(). This value is returned (and cleared) by
57 * jtag_execute_queue().
59 static int jtag_error = ERROR_OK;
61 static const char *jtag_event_strings[] =
63 [JTAG_TRST_ASSERTED] = "TAP reset",
64 [JTAG_TAP_EVENT_SETUP] = "TAP setup",
65 [JTAG_TAP_EVENT_ENABLE] = "TAP enabled",
66 [JTAG_TAP_EVENT_DISABLE] = "TAP disabled",
70 * JTAG adapters must initialize with TRST and SRST de-asserted
71 * (they're negative logic, so that means *high*)
73 static int jtag_trst = 0;
74 static int jtag_srst = 0;
77 * List all TAPs that have been created.
79 static jtag_tap_t *__jtag_all_taps = NULL;
81 * The number of TAPs in the __jtag_all_taps list, used to track the
82 * assigned chain position to new TAPs
84 static unsigned jtag_num_taps = 0;
86 static enum reset_types jtag_reset_config = RESET_NONE;
87 static tap_state_t cmd_queue_end_state = TAP_RESET;
88 tap_state_t cmd_queue_cur_state = TAP_RESET;
90 static bool jtag_verify_capture_ir = true;
91 static int jtag_verify = 1;
93 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
94 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
95 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
96 static int jtag_nsrst_assert_width = 0; /* width of assertion */
97 static int jtag_ntrst_assert_width = 0; /* width of assertion */
99 typedef struct jtag_event_callback_s
101 jtag_event_handler_t callback;
103 struct jtag_event_callback_s* next;
104 } jtag_event_callback_t;
106 /* callbacks to inform high-level handlers about JTAG state changes */
107 static jtag_event_callback_t *jtag_event_callbacks;
110 static int speed_khz = 0;
111 /* speed to fallback to when RCLK is requested but not supported */
112 static int rclk_fallback_speed_khz = 0;
113 static enum {CLOCK_MODE_SPEED, CLOCK_MODE_KHZ, CLOCK_MODE_RCLK} clock_mode;
114 static int jtag_speed = 0;
116 static struct jtag_interface_s *jtag = NULL;
119 jtag_interface_t *jtag_interface = NULL;
121 void jtag_set_error(int error)
123 if ((error == ERROR_OK) || (jtag_error != ERROR_OK))
127 int jtag_get_error(void)
131 int jtag_error_clear(void)
133 int temp = jtag_error;
134 jtag_error = ERROR_OK;
139 jtag_tap_t *jtag_all_taps(void)
141 return __jtag_all_taps;
144 unsigned jtag_tap_count(void)
146 return jtag_num_taps;
149 unsigned jtag_tap_count_enabled(void)
151 jtag_tap_t *t = jtag_all_taps();
162 /// Append a new TAP to the chain of all taps.
163 void jtag_tap_add(struct jtag_tap_s *t)
165 t->abs_chain_position = jtag_num_taps++;
167 jtag_tap_t **tap = &__jtag_all_taps;
169 tap = &(*tap)->next_tap;
173 /* returns a pointer to the n-th device in the scan chain */
174 static inline jtag_tap_t *jtag_tap_by_position(unsigned n)
176 jtag_tap_t *t = jtag_all_taps();
184 jtag_tap_t *jtag_tap_by_string(const char *s)
186 /* try by name first */
187 jtag_tap_t *t = jtag_all_taps();
191 if (0 == strcmp(t->dotted_name, s))
196 /* no tap found by name, so try to parse the name as a number */
198 if (parse_uint(s, &n) != ERROR_OK)
201 /* FIXME remove this numeric fallback code late June 2010, along
202 * with all info in the User's Guide that TAPs have numeric IDs.
203 * Also update "scan_chain" output to not display the numbers.
205 t = jtag_tap_by_position(n);
207 LOG_WARNING("Specify TAP '%s' by name, not number %u",
213 jtag_tap_t *jtag_tap_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
215 const char *cp = Jim_GetString(o, NULL);
216 jtag_tap_t *t = cp ? jtag_tap_by_string(cp) : NULL;
220 Jim_SetResult_sprintf(interp, "Tap '%s' could not be found", cp);
224 jtag_tap_t* jtag_tap_next_enabled(jtag_tap_t* p)
226 p = p ? p->next_tap : jtag_all_taps();
236 const char *jtag_tap_name(const jtag_tap_t *tap)
238 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
242 int jtag_register_event_callback(jtag_event_handler_t callback, void *priv)
244 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
246 if (callback == NULL)
248 return ERROR_INVALID_ARGUMENTS;
253 while ((*callbacks_p)->next)
254 callbacks_p = &((*callbacks_p)->next);
255 callbacks_p = &((*callbacks_p)->next);
258 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
259 (*callbacks_p)->callback = callback;
260 (*callbacks_p)->priv = priv;
261 (*callbacks_p)->next = NULL;
266 int jtag_unregister_event_callback(jtag_event_handler_t callback, void *priv)
268 jtag_event_callback_t **callbacks_p;
269 jtag_event_callback_t **next;
271 if (callback == NULL)
273 return ERROR_INVALID_ARGUMENTS;
276 for (callbacks_p = &jtag_event_callbacks;
277 *callbacks_p != NULL;
280 next = &((*callbacks_p)->next);
282 if ((*callbacks_p)->priv != priv)
285 if ((*callbacks_p)->callback == callback)
288 *callbacks_p = *next;
295 int jtag_call_event_callbacks(enum jtag_event event)
297 jtag_event_callback_t *callback = jtag_event_callbacks;
299 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
303 jtag_event_callback_t *next;
305 /* callback may remove itself */
306 next = callback->next;
307 callback->callback(event, callback->priv);
314 static void jtag_checks(void)
316 assert(jtag_trst == 0);
319 static void jtag_prelude(tap_state_t state)
323 assert(state != TAP_INVALID);
325 cmd_queue_cur_state = state;
328 void jtag_alloc_in_value32(scan_field_t *field)
330 interface_jtag_alloc_in_value32(field);
333 void jtag_add_ir_scan_noverify(int in_count, const scan_field_t *in_fields,
338 int retval = interface_jtag_add_ir_scan(in_count, in_fields, state);
339 jtag_set_error(retval);
343 void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
345 assert(state != TAP_RESET);
347 if (jtag_verify && jtag_verify_capture_ir)
349 /* 8 x 32 bit id's is enough for all invocations */
351 for (int j = 0; j < in_num_fields; j++)
353 /* if we are to run a verification of the ir scan, we need to get the input back.
354 * We may have to allocate space if the caller didn't ask for the input back.
356 in_fields[j].check_value = in_fields[j].tap->expected;
357 in_fields[j].check_mask = in_fields[j].tap->expected_mask;
359 jtag_add_scan_check(jtag_add_ir_scan_noverify, in_num_fields, in_fields, state);
362 jtag_add_ir_scan_noverify(in_num_fields, in_fields, state);
366 void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields,
369 assert(state != TAP_RESET);
373 int retval = interface_jtag_add_plain_ir_scan(
374 in_num_fields, in_fields, state);
375 jtag_set_error(retval);
378 void jtag_add_callback(jtag_callback1_t f, jtag_callback_data_t data0)
380 interface_jtag_add_callback(f, data0);
383 void jtag_add_callback4(jtag_callback_t f, jtag_callback_data_t data0,
384 jtag_callback_data_t data1, jtag_callback_data_t data2,
385 jtag_callback_data_t data3)
387 interface_jtag_add_callback4(f, data0, data1, data2, data3);
390 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
391 uint8_t *in_check_mask, int num_bits);
393 static int jtag_check_value_mask_callback(jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
395 return jtag_check_value_inner((uint8_t *)data0, (uint8_t *)data1, (uint8_t *)data2, (int)data3);
398 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
399 int in_num_fields, scan_field_t *in_fields, tap_state_t state)
401 for (int i = 0; i < in_num_fields; i++)
403 struct scan_field_s *field = &in_fields[i];
404 field->allocated = 0;
406 if (field->check_value || field->in_value)
408 interface_jtag_add_scan_check_alloc(field);
412 jtag_add_scan(in_num_fields, in_fields, state);
414 for (int i = 0; i < in_num_fields; i++)
416 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
418 /* this is synchronous for a minidriver */
419 jtag_add_callback4(jtag_check_value_mask_callback, (jtag_callback_data_t)in_fields[i].in_value,
420 (jtag_callback_data_t)in_fields[i].check_value,
421 (jtag_callback_data_t)in_fields[i].check_mask,
422 (jtag_callback_data_t)in_fields[i].num_bits);
424 if (in_fields[i].allocated)
426 free(in_fields[i].in_value);
428 if (in_fields[i].modified)
430 in_fields[i].in_value = NULL;
435 void jtag_add_dr_scan_check(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
439 jtag_add_scan_check(jtag_add_dr_scan, in_num_fields, in_fields, state);
442 jtag_add_dr_scan(in_num_fields, in_fields, state);
447 void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields,
450 assert(state != TAP_RESET);
455 retval = interface_jtag_add_dr_scan(in_num_fields, in_fields, state);
456 jtag_set_error(retval);
459 void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields,
462 assert(state != TAP_RESET);
467 retval = interface_jtag_add_plain_dr_scan(in_num_fields, in_fields, state);
468 jtag_set_error(retval);
471 void jtag_add_dr_out(jtag_tap_t* tap,
472 int num_fields, const int* num_bits, const uint32_t* value,
473 tap_state_t end_state)
475 assert(end_state != TAP_RESET);
476 assert(end_state != TAP_INVALID);
478 cmd_queue_cur_state = end_state;
480 interface_jtag_add_dr_out(tap,
481 num_fields, num_bits, value,
485 void jtag_add_tlr(void)
487 jtag_prelude(TAP_RESET);
488 jtag_set_error(interface_jtag_add_tlr());
490 /* NOTE: order here matches TRST path in jtag_add_reset() */
491 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
492 jtag_notify_event(JTAG_TRST_ASSERTED);
495 void jtag_add_pathmove(int num_states, const tap_state_t *path)
497 tap_state_t cur_state = cmd_queue_cur_state;
499 /* the last state has to be a stable state */
500 if (!tap_is_state_stable(path[num_states - 1]))
502 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
503 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
507 for (int i = 0; i < num_states; i++)
509 if (path[i] == TAP_RESET)
511 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
512 jtag_set_error(ERROR_JTAG_STATE_INVALID);
516 if (tap_state_transition(cur_state, true) != path[i]
517 && tap_state_transition(cur_state, false) != path[i])
519 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
520 tap_state_name(cur_state), tap_state_name(path[i]));
521 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
529 jtag_set_error(interface_jtag_add_pathmove(num_states, path));
530 cmd_queue_cur_state = path[num_states - 1];
533 int jtag_add_statemove(tap_state_t goal_state)
535 tap_state_t cur_state = cmd_queue_cur_state;
537 LOG_DEBUG("cur_state=%s goal_state=%s",
538 tap_state_name(cur_state),
539 tap_state_name(goal_state));
542 if (goal_state == cur_state)
543 ; /* nothing to do */
544 else if (goal_state == TAP_RESET)
548 else if (tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state))
550 unsigned tms_bits = tap_get_tms_path(cur_state, goal_state);
551 unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
552 tap_state_t moves[8];
553 assert(tms_count < DIM(moves));
555 for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1)
557 bool bit = tms_bits & 1;
559 cur_state = tap_state_transition(cur_state, bit);
560 moves[i] = cur_state;
563 jtag_add_pathmove(tms_count, moves);
565 else if (tap_state_transition(cur_state, true) == goal_state
566 || tap_state_transition(cur_state, false) == goal_state)
568 jtag_add_pathmove(1, &goal_state);
577 void jtag_add_runtest(int num_cycles, tap_state_t state)
580 jtag_set_error(interface_jtag_add_runtest(num_cycles, state));
584 void jtag_add_clocks(int num_cycles)
586 if (!tap_is_state_stable(cmd_queue_cur_state))
588 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
589 tap_state_name(cmd_queue_cur_state));
590 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
597 jtag_set_error(interface_jtag_add_clocks(num_cycles));
601 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
603 int trst_with_tlr = 0;
607 /* Without SRST, we must use target-specific JTAG operations
608 * on each target; callers should not be requesting SRST when
609 * that signal doesn't exist.
611 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
612 * can kick in even if the JTAG adapter can't drive TRST.
615 if (!(jtag_reset_config & RESET_HAS_SRST)) {
616 LOG_ERROR("BUG: can't assert SRST");
617 jtag_set_error(ERROR_FAIL);
620 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
621 && !req_tlr_or_trst) {
622 LOG_ERROR("BUG: can't assert only SRST");
623 jtag_set_error(ERROR_FAIL);
629 /* JTAG reset (entry to TAP_RESET state) can always be achieved
630 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
631 * state first. TRST accelerates it, and bypasses those states.
633 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
634 * can kick in even if the JTAG adapter can't drive SRST.
636 if (req_tlr_or_trst) {
637 if (!(jtag_reset_config & RESET_HAS_TRST))
639 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
646 /* Maybe change TRST and/or SRST signal state */
647 if (jtag_srst != new_srst || jtag_trst != new_trst) {
650 retval = interface_jtag_add_reset(new_trst, new_srst);
651 if (retval != ERROR_OK)
652 jtag_set_error(retval);
654 retval = jtag_execute_queue();
656 if (retval != ERROR_OK) {
657 LOG_ERROR("TRST/SRST error %d", retval);
662 /* SRST resets everything hooked up to that signal */
663 if (jtag_srst != new_srst) {
664 jtag_srst = new_srst;
667 LOG_DEBUG("SRST line asserted");
668 if (jtag_nsrst_assert_width)
669 jtag_add_sleep(jtag_nsrst_assert_width * 1000);
672 LOG_DEBUG("SRST line released");
673 if (jtag_nsrst_delay)
674 jtag_add_sleep(jtag_nsrst_delay * 1000);
678 /* Maybe enter the JTAG TAP_RESET state ...
679 * - using only TMS, TCK, and the JTAG state machine
680 * - or else more directly, using TRST
682 * TAP_RESET should be invisible to non-debug parts of the system.
685 LOG_DEBUG("JTAG reset with TLR instead of TRST");
686 jtag_set_end_state(TAP_RESET);
689 } else if (jtag_trst != new_trst) {
690 jtag_trst = new_trst;
692 LOG_DEBUG("TRST line asserted");
693 tap_set_state(TAP_RESET);
694 if (jtag_ntrst_assert_width)
695 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
697 LOG_DEBUG("TRST line released");
698 if (jtag_ntrst_delay)
699 jtag_add_sleep(jtag_ntrst_delay * 1000);
701 /* We just asserted nTRST, so we're now in TAP_RESET.
702 * Inform possible listeners about this, now that
703 * JTAG instructions and data can be shifted. This
704 * sequence must match jtag_add_tlr().
706 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
707 jtag_notify_event(JTAG_TRST_ASSERTED);
712 tap_state_t jtag_set_end_state(tap_state_t state)
714 if ((state == TAP_DRSHIFT)||(state == TAP_IRSHIFT))
716 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
719 if (state != TAP_INVALID)
720 cmd_queue_end_state = state;
721 return cmd_queue_end_state;
724 tap_state_t jtag_get_end_state(void)
726 return cmd_queue_end_state;
729 void jtag_add_sleep(uint32_t us)
731 /// @todo Here, keep_alive() appears to be a layering violation!!!
733 jtag_set_error(interface_jtag_add_sleep(us));
736 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
737 uint8_t *in_check_mask, int num_bits)
739 int retval = ERROR_OK;
741 int compare_failed = 0;
744 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
746 compare_failed = buf_cmp(captured, in_check_value, num_bits);
748 if (compare_failed) {
749 char *captured_str, *in_check_value_str;
750 int bits = (num_bits > DEBUG_JTAG_IOZ)
754 /* NOTE: we've lost diagnostic context here -- 'which tap' */
756 captured_str = buf_to_str(captured, bits, 16);
757 in_check_value_str = buf_to_str(in_check_value, bits, 16);
759 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
761 LOG_WARNING(" check_value: 0x%s", in_check_value_str);
764 free(in_check_value_str);
767 char *in_check_mask_str;
769 in_check_mask_str = buf_to_str(in_check_mask, bits, 16);
770 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str);
771 free(in_check_mask_str);
774 retval = ERROR_JTAG_QUEUE_FAILED;
779 void jtag_check_value_mask(scan_field_t *field, uint8_t *value, uint8_t *mask)
781 assert(field->in_value != NULL);
785 /* no checking to do */
789 jtag_execute_queue_noclear();
791 int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
792 jtag_set_error(retval);
797 int default_interface_jtag_execute_queue(void)
801 LOG_ERROR("No JTAG interface configured yet. "
802 "Issue 'init' command in startup scripts "
803 "before communicating with targets.");
807 return jtag->execute_queue();
810 void jtag_execute_queue_noclear(void)
812 jtag_flush_queue_count++;
813 jtag_set_error(interface_jtag_execute_queue());
816 int jtag_get_flush_queue_count(void)
818 return jtag_flush_queue_count;
821 int jtag_execute_queue(void)
823 jtag_execute_queue_noclear();
824 return jtag_error_clear();
827 static int jtag_reset_callback(enum jtag_event event, void *priv)
829 jtag_tap_t *tap = priv;
831 if (event == JTAG_TRST_ASSERTED)
833 tap->enabled = !tap->disabled_after_reset;
835 /* current instruction is either BYPASS or IDCODE */
836 buf_set_ones(tap->cur_instr, tap->ir_length);
843 void jtag_sleep(uint32_t us)
845 alive_sleep(us/1000);
848 /* Maximum number of enabled JTAG devices we expect in the scan chain,
849 * plus one (to detect garbage at the end). Devices that don't support
850 * IDCODE take up fewer bits, possibly allowing a few more devices.
852 #define JTAG_MAX_CHAIN_SIZE 20
854 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
855 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
856 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
858 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
859 * know that no valid TAP will have it as an IDCODE value.
861 #define END_OF_CHAIN_FLAG 0x000000ff
863 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
865 scan_field_t field = {
867 .num_bits = num_idcode * 32,
868 .out_value = idcode_buffer,
869 .in_value = idcode_buffer,
872 // initialize to the end of chain ID value
873 for (unsigned i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
874 buf_set_u32(idcode_buffer, i * 32, 32, END_OF_CHAIN_FLAG);
876 jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE);
878 return jtag_execute_queue();
881 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
883 uint8_t zero_check = 0x0;
884 uint8_t one_check = 0xff;
886 for (unsigned i = 0; i < count * 4; i++)
888 zero_check |= idcodes[i];
889 one_check &= idcodes[i];
892 /* if there wasn't a single non-zero bit or if all bits were one,
893 * the scan is not valid */
894 if (zero_check == 0x00 || one_check == 0xff)
896 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
897 (zero_check == 0x00) ? "zeroes" : "ones");
898 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
904 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
905 const char *name, uint32_t idcode)
907 log_printf_lf(level, __FILE__, __LINE__, __FUNCTION__,
908 "JTAG tap: %s %16.16s: 0x%08x "
909 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
911 (unsigned int)idcode,
912 (unsigned int)EXTRACT_MFG(idcode),
913 (unsigned int)EXTRACT_PART(idcode),
914 (unsigned int)EXTRACT_VER(idcode));
917 static bool jtag_idcode_is_final(uint32_t idcode)
920 * Some devices, such as AVR8, will output all 1's instead
921 * of TDI input value at end of chain. Allow those values
922 * instead of failing.
924 return idcode == END_OF_CHAIN_FLAG || idcode == 0xFFFFFFFF;
928 * This helper checks that remaining bits in the examined chain data are
929 * all as expected, but a single JTAG device requires only 64 bits to be
930 * read back correctly. This can help identify and diagnose problems
931 * with the JTAG chain earlier, gives more helpful/explicit error messages.
932 * Returns TRUE iff garbage was found.
934 static bool jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
936 bool triggered = false;
937 for (; count < max - 31; count += 32)
939 uint32_t idcode = buf_get_u32(idcodes, count, 32);
940 // do not trigger the warning if the data looks good
941 if (!triggered && jtag_idcode_is_final(idcode))
943 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
944 count, (unsigned int)idcode);
950 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s *tap)
952 /* ignore expected BYPASS codes; warn otherwise */
953 if (0 == tap->expected_ids_cnt && !tap->idcode)
956 /* Loop over the expected identification codes and test for a match */
958 for (ii = 0; ii < tap->expected_ids_cnt; ii++)
960 if (tap->idcode == tap->expected_ids[ii])
963 /* treat "-expected-id 0" as a "don't-warn" wildcard */
964 if (0 == tap->expected_ids[ii])
968 /* If none of the expected ids matched, warn */
969 jtag_examine_chain_display(LOG_LVL_WARNING, "UNEXPECTED",
970 tap->dotted_name, tap->idcode);
971 for (ii = 0; ii < tap->expected_ids_cnt; ii++)
974 snprintf(msg, sizeof(msg), "expected %hhu of %hhu",
975 ii + 1, tap->expected_ids_cnt);
976 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
977 tap->dotted_name, tap->expected_ids[ii]);
982 /* Try to examine chain layout according to IEEE 1149.1 §12
983 * This is called a "blind interrogation" of the scan chain.
985 static int jtag_examine_chain(void)
987 uint8_t idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
990 /* DR scan to collect BYPASS or IDCODE register contents.
991 * Then make sure the scan data has both ones and zeroes.
993 jtag_examine_chain_execute(idcode_buffer, JTAG_MAX_CHAIN_SIZE);
994 if (!jtag_examine_chain_check(idcode_buffer, JTAG_MAX_CHAIN_SIZE))
995 return ERROR_JTAG_INIT_FAILED;
997 /* point at the 1st tap */
998 jtag_tap_t *tap = jtag_tap_next_enabled(NULL);
1001 LOG_ERROR("JTAG: No taps enabled?");
1002 return ERROR_JTAG_INIT_FAILED;
1006 tap && bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;
1007 tap = jtag_tap_next_enabled(tap))
1009 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1011 if ((idcode & 1) == 0)
1013 /* LSB must not be 0, this indicates a device in bypass */
1014 LOG_WARNING("TAP %s does not have IDCODE",
1017 tap->hasidcode = false;
1023 /* Friendly devices support IDCODE */
1024 tap->hasidcode = true;
1025 jtag_examine_chain_display(LOG_LVL_INFO, "tap/device found",
1026 tap->dotted_name, idcode);
1030 tap->idcode = idcode;
1032 /* ensure the TAP ID matches what was expected */
1033 if (!jtag_examine_chain_match_tap(tap))
1034 return ERROR_JTAG_INIT_FAILED;
1037 /* Fail if too many TAPs were enabled for us to verify them all. */
1039 LOG_ERROR("Too many TAPs enabled; '%s' ignored.",
1041 return ERROR_JTAG_INIT_FAILED;
1044 /* After those IDCODE or BYPASS register values should be
1045 * only the data we fed into the scan chain.
1047 if (jtag_examine_chain_end(idcode_buffer, bit_count,
1048 8 * sizeof(idcode_buffer))) {
1049 LOG_ERROR("double-check your JTAG setup (interface, "
1050 "speed, TAPs, ...)");
1051 return ERROR_JTAG_INIT_FAILED;
1058 * Validate the date loaded by entry to the Capture-IR state, to help
1059 * find errors related to scan chain configuration (wrong IR lengths)
1062 * Entry state can be anything. On non-error exit, all TAPs are in
1063 * bypass mode. On error exits, the scan chain is reset.
1065 static int jtag_validate_ircapture(void)
1068 int total_ir_length = 0;
1069 uint8_t *ir_test = NULL;
1075 for (tap = NULL, total_ir_length = 0;
1076 (tap = jtag_tap_next_enabled(tap)) != NULL;
1077 total_ir_length += tap->ir_length)
1080 /* increase length to add 2 bit sentinel after scan */
1081 total_ir_length += 2;
1083 ir_test = malloc(CEIL(total_ir_length, 8));
1084 if (ir_test == NULL)
1087 /* after this scan, all TAPs will capture BYPASS instructions */
1088 buf_set_ones(ir_test, total_ir_length);
1091 field.num_bits = total_ir_length;
1092 field.out_value = ir_test;
1093 field.in_value = ir_test;
1095 jtag_add_plain_ir_scan(1, &field, TAP_IDLE);
1097 LOG_DEBUG("IR capture validation scan");
1098 retval = jtag_execute_queue();
1099 if (retval != ERROR_OK)
1106 tap = jtag_tap_next_enabled(tap);
1113 /* Validate the two LSBs, which must be 01 per JTAG spec.
1114 * REVISIT we might be able to verify some MSBs too, using
1115 * ircapture/irmask attributes.
1117 val = buf_get_u32(ir_test, chain_pos, tap->ir_length);
1118 if ((val & 0x3) != 1) {
1119 LOG_ERROR("%s: IR capture error; saw 0x%0*x not 0x..1",
1121 (tap->ir_length + 7) / tap->ir_length,
1124 retval = ERROR_JTAG_INIT_FAILED;
1128 LOG_DEBUG("%s: IR capture 0x%0*x", jtag_tap_name(tap),
1129 (tap->ir_length + 7) / tap->ir_length, val);
1130 chain_pos += tap->ir_length;
1133 /* verify the '11' sentinel we wrote is returned at the end */
1134 val = buf_get_u32(ir_test, chain_pos, 2);
1137 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1139 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1142 retval = ERROR_JTAG_INIT_FAILED;
1147 if (retval != ERROR_OK) {
1149 jtag_execute_queue();
1155 void jtag_tap_init(jtag_tap_t *tap)
1157 assert(0 != tap->ir_length);
1159 /// @todo fix, this allocates one byte per bit for all three fields!
1160 tap->expected = malloc(tap->ir_length);
1161 tap->expected_mask = malloc(tap->ir_length);
1162 tap->cur_instr = malloc(tap->ir_length);
1164 /// @todo cope sanely with ir_length bigger than 32 bits
1165 buf_set_u32(tap->expected, 0, tap->ir_length, tap->ir_capture_value);
1166 buf_set_u32(tap->expected_mask, 0, tap->ir_length, tap->ir_capture_mask);
1167 buf_set_ones(tap->cur_instr, tap->ir_length);
1169 // place TAP in bypass mode
1171 // register the reset callback for the TAP
1172 jtag_register_event_callback(&jtag_reset_callback, tap);
1174 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1175 "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1176 tap->abs_chain_position, tap->ir_length,
1177 (unsigned) tap->ir_capture_value,
1178 (unsigned) tap->ir_capture_mask);
1182 void jtag_tap_free(jtag_tap_t *tap)
1184 jtag_unregister_event_callback(&jtag_reset_callback, tap);
1186 /// @todo is anything missing? no memory leaks please
1187 free((void *)tap->expected);
1188 free((void *)tap->expected_ids);
1189 free((void *)tap->chip);
1190 free((void *)tap->tapname);
1191 free((void *)tap->dotted_name);
1195 int jtag_interface_init(struct command_context_s *cmd_ctx)
1200 if (!jtag_interface)
1202 /* nothing was previously specified by "interface" command */
1203 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1204 return ERROR_JTAG_INVALID_INTERFACE;
1207 jtag = jtag_interface;
1208 if (jtag_interface->init() != ERROR_OK)
1211 return ERROR_JTAG_INIT_FAILED;
1214 int requested_khz = jtag_get_speed_khz();
1215 int actual_khz = requested_khz;
1216 int retval = jtag_get_speed_readable(&actual_khz);
1217 if (ERROR_OK != retval)
1218 LOG_INFO("interface specific clock speed value %d", jtag_get_speed());
1219 else if (actual_khz)
1221 if ((CLOCK_MODE_RCLK == clock_mode)
1222 || ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz))
1224 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1228 LOG_INFO("clock speed %d kHz", actual_khz);
1231 LOG_INFO("RCLK (adaptive clock speed)");
1236 int jtag_init_inner(struct command_context_s *cmd_ctx)
1240 bool issue_setup = true;
1242 LOG_DEBUG("Init JTAG chain");
1244 tap = jtag_tap_next_enabled(NULL);
1246 LOG_ERROR("There are no enabled taps?");
1247 return ERROR_JTAG_INIT_FAILED;
1251 if ((retval = jtag_execute_queue()) != ERROR_OK)
1254 /* examine chain first, as this could discover the real chain layout */
1255 if (jtag_examine_chain() != ERROR_OK)
1257 LOG_ERROR("Trying to use configured scan chain anyway...");
1258 issue_setup = false;
1261 if (jtag_validate_ircapture() != ERROR_OK)
1263 LOG_WARNING("Errors during IR capture, continuing anyway...");
1264 issue_setup = false;
1268 jtag_notify_event(JTAG_TAP_EVENT_SETUP);
1270 LOG_WARNING("Bypassing JTAG setup events due to errors");
1276 int jtag_interface_quit(void)
1278 if (!jtag || !jtag->quit)
1281 // close the JTAG interface
1282 int result = jtag->quit();
1283 if (ERROR_OK != result)
1284 LOG_ERROR("failed: %d", result);
1290 int jtag_init_reset(struct command_context_s *cmd_ctx)
1294 if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK)
1297 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / TLR");
1299 /* Reset can happen after a power cycle.
1301 * Ideally we would only assert TRST or run TLR before the target reset.
1303 * However w/srst_pulls_trst, trst is asserted together with the target
1304 * reset whether we want it or not.
1306 * NB! Some targets have JTAG circuitry disabled until a
1307 * trst & srst has been asserted.
1309 * NB! here we assume nsrst/ntrst delay are sufficient!
1311 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1314 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1315 if (jtag_reset_config & RESET_HAS_SRST)
1317 jtag_add_reset(1, 1);
1318 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1319 jtag_add_reset(0, 1);
1321 jtag_add_reset(0, 0);
1322 if ((retval = jtag_execute_queue()) != ERROR_OK)
1325 /* Check that we can communication on the JTAG chain + eventually we want to
1326 * be able to perform enumeration only after OpenOCD has started
1327 * telnet and GDB server
1329 * That would allow users to more easily perform any magic they need to before
1332 return jtag_init_inner(cmd_ctx);
1335 int jtag_init(struct command_context_s *cmd_ctx)
1338 if ((retval = jtag_interface_init(cmd_ctx)) != ERROR_OK)
1341 if (Jim_Eval_Named(interp, "jtag_init", __FILE__, __LINE__) != JIM_OK)
1347 unsigned jtag_get_speed_khz(void)
1352 static int jtag_khz_to_speed(unsigned khz, int* speed)
1354 LOG_DEBUG("convert khz to interface specific speed value");
1358 LOG_DEBUG("have interface set up");
1360 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1361 if (ERROR_OK != retval)
1365 *speed = speed_div1;
1370 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int* speed)
1372 int retval = jtag_khz_to_speed(0, speed);
1373 if ((ERROR_OK != retval) && fallback_speed_khz)
1375 LOG_DEBUG("trying fallback speed...");
1376 retval = jtag_khz_to_speed(fallback_speed_khz, speed);
1381 static int jtag_set_speed(int speed)
1384 /* this command can be called during CONFIG,
1385 * in which case jtag isn't initialized */
1386 return jtag ? jtag->speed(speed) : ERROR_OK;
1389 int jtag_config_speed(int speed)
1391 LOG_DEBUG("handle jtag speed");
1392 clock_mode = CLOCK_MODE_SPEED;
1393 return jtag_set_speed(speed);
1396 int jtag_config_khz(unsigned khz)
1398 LOG_DEBUG("handle jtag khz");
1399 clock_mode = CLOCK_MODE_KHZ;
1401 int retval = jtag_khz_to_speed(khz, &speed);
1402 return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1405 int jtag_config_rclk(unsigned fallback_speed_khz)
1407 LOG_DEBUG("handle jtag rclk");
1408 clock_mode = CLOCK_MODE_RCLK;
1409 rclk_fallback_speed_khz = fallback_speed_khz;
1411 int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1412 return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1415 int jtag_get_speed(void)
1420 case CLOCK_MODE_SPEED:
1423 case CLOCK_MODE_KHZ:
1424 jtag_khz_to_speed(jtag_get_speed_khz(), &speed);
1426 case CLOCK_MODE_RCLK:
1427 jtag_rclk_to_speed(rclk_fallback_speed_khz, &speed);
1430 LOG_ERROR("BUG: unknown jtag clock mode");
1437 int jtag_get_speed_readable(int *khz)
1439 return jtag ? jtag->speed_div(jtag_get_speed(), khz) : ERROR_OK;
1442 void jtag_set_verify(bool enable)
1444 jtag_verify = enable;
1447 bool jtag_will_verify()
1452 void jtag_set_verify_capture_ir(bool enable)
1454 jtag_verify_capture_ir = enable;
1457 bool jtag_will_verify_capture_ir()
1459 return jtag_verify_capture_ir;
1462 int jtag_power_dropout(int *dropout)
1464 return jtag->power_dropout(dropout);
1467 int jtag_srst_asserted(int *srst_asserted)
1469 return jtag->srst_asserted(srst_asserted);
1472 enum reset_types jtag_get_reset_config(void)
1474 return jtag_reset_config;
1476 void jtag_set_reset_config(enum reset_types type)
1478 jtag_reset_config = type;
1481 int jtag_get_trst(void)
1485 int jtag_get_srst(void)
1490 void jtag_set_nsrst_delay(unsigned delay)
1492 jtag_nsrst_delay = delay;
1494 unsigned jtag_get_nsrst_delay(void)
1496 return jtag_nsrst_delay;
1498 void jtag_set_ntrst_delay(unsigned delay)
1500 jtag_ntrst_delay = delay;
1502 unsigned jtag_get_ntrst_delay(void)
1504 return jtag_ntrst_delay;
1508 void jtag_set_nsrst_assert_width(unsigned delay)
1510 jtag_nsrst_assert_width = delay;
1512 unsigned jtag_get_nsrst_assert_width(void)
1514 return jtag_nsrst_assert_width;
1516 void jtag_set_ntrst_assert_width(unsigned delay)
1518 jtag_ntrst_assert_width = delay;
1520 unsigned jtag_get_ntrst_assert_width(void)
1522 return jtag_ntrst_assert_width;