1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2009 Zachary T Welch *
13 * zw@superlucidity.net *
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
] = "JTAG controller reset (TLR or TRST)",
64 [JTAG_TAP_EVENT_ENABLE
] = "TAP enabled",
65 [JTAG_TAP_EVENT_POST_RESET
] = "post reset",
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 */
97 typedef struct jtag_event_callback_s
99 jtag_event_handler_t callback
;
101 struct jtag_event_callback_s
* next
;
102 } jtag_event_callback_t
;
104 /* callbacks to inform high-level handlers about JTAG state changes */
105 static jtag_event_callback_t
*jtag_event_callbacks
;
108 static int speed_khz
= 0;
109 /* speed to fallback to when RCLK is requested but not supported */
110 static int rclk_fallback_speed_khz
= 0;
111 static enum {CLOCK_MODE_SPEED
, CLOCK_MODE_KHZ
, CLOCK_MODE_RCLK
} clock_mode
;
112 static int jtag_speed
= 0;
114 static struct jtag_interface_s
*jtag
= NULL
;
117 jtag_interface_t
*jtag_interface
= NULL
;
119 void jtag_set_error(int error
)
121 if ((error
== ERROR_OK
) || (jtag_error
!= ERROR_OK
))
125 int jtag_get_error(void)
129 int jtag_error_clear(void)
131 int temp
= jtag_error
;
132 jtag_error
= ERROR_OK
;
137 jtag_tap_t
*jtag_all_taps(void)
139 return __jtag_all_taps
;
142 unsigned jtag_tap_count(void)
144 return jtag_num_taps
;
147 unsigned jtag_tap_count_enabled(void)
149 jtag_tap_t
*t
= jtag_all_taps();
160 /// Append a new TAP to the chain of all taps.
161 void jtag_tap_add(struct jtag_tap_s
*t
)
163 t
->abs_chain_position
= jtag_num_taps
++;
165 jtag_tap_t
**tap
= &__jtag_all_taps
;
167 tap
= &(*tap
)->next_tap
;
171 /* returns a pointer to the n-th device in the scan chain */
172 static inline jtag_tap_t
*jtag_tap_by_position(unsigned n
)
174 jtag_tap_t
*t
= jtag_all_taps();
182 jtag_tap_t
*jtag_tap_by_string(const char *s
)
184 /* try by name first */
185 jtag_tap_t
*t
= jtag_all_taps();
189 if (0 == strcmp(t
->dotted_name
, s
))
194 /* no tap found by name, so try to parse the name as a number */
196 if (parse_uint(s
, &n
) != ERROR_OK
)
199 /* FIXME remove this numeric fallback code late June 2010, along
200 * with all info in the User's Guide that TAPs have numeric IDs.
201 * Also update "scan_chain" output to not display the numbers.
203 t
= jtag_tap_by_position(n
);
205 LOG_WARNING("Specify TAP '%s' by name, not number %u",
211 jtag_tap_t
*jtag_tap_by_jim_obj(Jim_Interp
*interp
, Jim_Obj
*o
)
213 const char *cp
= Jim_GetString(o
, NULL
);
214 jtag_tap_t
*t
= cp
? jtag_tap_by_string(cp
) : NULL
;
218 Jim_SetResult_sprintf(interp
, "Tap '%s' could not be found", cp
);
222 jtag_tap_t
* jtag_tap_next_enabled(jtag_tap_t
* p
)
224 p
= p
? p
->next_tap
: jtag_all_taps();
234 const char *jtag_tap_name(const jtag_tap_t
*tap
)
236 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
240 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
242 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
244 if (callback
== NULL
)
246 return ERROR_INVALID_ARGUMENTS
;
251 while ((*callbacks_p
)->next
)
252 callbacks_p
= &((*callbacks_p
)->next
);
253 callbacks_p
= &((*callbacks_p
)->next
);
256 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
257 (*callbacks_p
)->callback
= callback
;
258 (*callbacks_p
)->priv
= priv
;
259 (*callbacks_p
)->next
= NULL
;
264 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
266 jtag_event_callback_t
**callbacks_p
;
267 jtag_event_callback_t
**next
;
269 if (callback
== NULL
)
271 return ERROR_INVALID_ARGUMENTS
;
274 for (callbacks_p
= &jtag_event_callbacks
;
275 *callbacks_p
!= NULL
;
278 next
= &((*callbacks_p
)->next
);
280 if ((*callbacks_p
)->priv
!= priv
)
283 if ((*callbacks_p
)->callback
== callback
)
286 *callbacks_p
= *next
;
293 int jtag_call_event_callbacks(enum jtag_event event
)
295 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
297 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
301 jtag_event_callback_t
*next
;
303 /* callback may remove itself */
304 next
= callback
->next
;
305 callback
->callback(event
, callback
->priv
);
312 static void jtag_checks(void)
314 assert(jtag_trst
== 0);
317 static void jtag_prelude(tap_state_t state
)
321 assert(state
!= TAP_INVALID
);
323 cmd_queue_cur_state
= state
;
326 void jtag_alloc_in_value32(scan_field_t
*field
)
328 interface_jtag_alloc_in_value32(field
);
331 void jtag_add_ir_scan_noverify(int in_count
, const scan_field_t
*in_fields
,
336 int retval
= interface_jtag_add_ir_scan(in_count
, in_fields
, state
);
337 jtag_set_error(retval
);
341 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
343 assert(state
!= TAP_RESET
);
345 if (jtag_verify
&& jtag_verify_capture_ir
)
347 /* 8 x 32 bit id's is enough for all invocations */
349 for (int j
= 0; j
< in_num_fields
; j
++)
351 /* if we are to run a verification of the ir scan, we need to get the input back.
352 * We may have to allocate space if the caller didn't ask for the input back.
354 in_fields
[j
].check_value
= in_fields
[j
].tap
->expected
;
355 in_fields
[j
].check_mask
= in_fields
[j
].tap
->expected_mask
;
357 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
360 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
364 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
,
367 assert(state
!= TAP_RESET
);
371 int retval
= interface_jtag_add_plain_ir_scan(
372 in_num_fields
, in_fields
, state
);
373 jtag_set_error(retval
);
376 void jtag_add_callback(jtag_callback1_t f
, jtag_callback_data_t data0
)
378 interface_jtag_add_callback(f
, data0
);
381 void jtag_add_callback4(jtag_callback_t f
, jtag_callback_data_t data0
,
382 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
383 jtag_callback_data_t data3
)
385 interface_jtag_add_callback4(f
, data0
, data1
, data2
, data3
);
388 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
389 uint8_t *in_check_mask
, int num_bits
);
391 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
)
393 return jtag_check_value_inner((uint8_t *)data0
, (uint8_t *)data1
, (uint8_t *)data2
, (int)data3
);
396 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
397 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
399 for (int i
= 0; i
< in_num_fields
; i
++)
401 struct scan_field_s
*field
= &in_fields
[i
];
402 field
->allocated
= 0;
404 if (field
->check_value
|| field
->in_value
)
406 interface_jtag_add_scan_check_alloc(field
);
410 jtag_add_scan(in_num_fields
, in_fields
, state
);
412 for (int i
= 0; i
< in_num_fields
; i
++)
414 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
416 /* this is synchronous for a minidriver */
417 jtag_add_callback4(jtag_check_value_mask_callback
, (jtag_callback_data_t
)in_fields
[i
].in_value
,
418 (jtag_callback_data_t
)in_fields
[i
].check_value
,
419 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
420 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
422 if (in_fields
[i
].allocated
)
424 free(in_fields
[i
].in_value
);
426 if (in_fields
[i
].modified
)
428 in_fields
[i
].in_value
= NULL
;
433 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
437 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
440 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
445 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
448 assert(state
!= TAP_RESET
);
453 retval
= interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
454 jtag_set_error(retval
);
457 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
460 assert(state
!= TAP_RESET
);
465 retval
= interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
466 jtag_set_error(retval
);
469 void jtag_add_dr_out(jtag_tap_t
* tap
,
470 int num_fields
, const int* num_bits
, const uint32_t* value
,
471 tap_state_t end_state
)
473 assert(end_state
!= TAP_RESET
);
475 assert(end_state
!= TAP_INVALID
);
477 cmd_queue_cur_state
= end_state
;
479 interface_jtag_add_dr_out(tap
,
480 num_fields
, num_bits
, value
,
484 void jtag_add_tlr(void)
486 jtag_prelude(TAP_RESET
);
487 jtag_set_error(interface_jtag_add_tlr());
491 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
494 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
496 tap_state_t cur_state
= cmd_queue_cur_state
;
498 /* the last state has to be a stable state */
499 if (!tap_is_state_stable(path
[num_states
- 1]))
501 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
502 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
506 for (int i
= 0; i
< num_states
; i
++)
508 if (path
[i
] == TAP_RESET
)
510 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
511 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
515 if (tap_state_transition(cur_state
, true) != path
[i
]
516 && tap_state_transition(cur_state
, false) != path
[i
])
518 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
519 tap_state_name(cur_state
), tap_state_name(path
[i
]));
520 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
528 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
529 cmd_queue_cur_state
= path
[num_states
- 1];
532 int jtag_add_statemove(tap_state_t goal_state
)
534 tap_state_t cur_state
= cmd_queue_cur_state
;
536 LOG_DEBUG("cur_state=%s goal_state=%s",
537 tap_state_name(cur_state
),
538 tap_state_name(goal_state
));
541 if (goal_state
== cur_state
)
542 ; /* nothing to do */
543 else if (goal_state
== TAP_RESET
)
547 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
))
549 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
550 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
551 tap_state_t moves
[8];
552 assert(tms_count
< DIM(moves
));
554 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1)
556 bool bit
= tms_bits
& 1;
558 cur_state
= tap_state_transition(cur_state
, bit
);
559 moves
[i
] = cur_state
;
562 jtag_add_pathmove(tms_count
, moves
);
564 else if (tap_state_transition(cur_state
, true) == goal_state
565 || tap_state_transition(cur_state
, false) == goal_state
)
567 jtag_add_pathmove(1, &goal_state
);
576 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
579 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
583 void jtag_add_clocks(int num_cycles
)
585 if (!tap_is_state_stable(cmd_queue_cur_state
))
587 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
588 tap_state_name(cmd_queue_cur_state
));
589 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
596 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
600 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
602 int trst_with_tlr
= 0;
606 /* Without SRST, we must use target-specific JTAG operations
607 * on each target; callers should not be requesting SRST when
608 * that signal doesn't exist.
610 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
611 * can kick in even if the JTAG adapter can't drive TRST.
614 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
615 LOG_ERROR("BUG: can't assert SRST");
616 jtag_set_error(ERROR_FAIL
);
619 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
620 && !req_tlr_or_trst
) {
621 LOG_ERROR("BUG: can't assert only SRST");
622 jtag_set_error(ERROR_FAIL
);
628 /* JTAG reset (entry to TAP_RESET state) can always be achieved
629 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
630 * state first. TRST accelerates it, and bypasses those states.
632 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
633 * can kick in even if the JTAG adapter can't drive SRST.
635 if (req_tlr_or_trst
) {
636 if (!(jtag_reset_config
& RESET_HAS_TRST
))
638 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
645 /* Maybe change TRST and/or SRST signal state */
646 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
649 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
650 if (retval
!= ERROR_OK
)
651 jtag_set_error(retval
);
653 retval
= jtag_execute_queue();
655 if (retval
!= ERROR_OK
) {
656 LOG_ERROR("TRST/SRST error %d", retval
);
661 /* SRST resets everything hooked up to that signal */
662 if (jtag_srst
!= new_srst
) {
663 jtag_srst
= new_srst
;
665 LOG_DEBUG("SRST line asserted");
667 LOG_DEBUG("SRST line released");
668 if (jtag_nsrst_delay
)
669 jtag_add_sleep(jtag_nsrst_delay
* 1000);
673 /* Maybe enter the JTAG TAP_RESET state ...
674 * - using only TMS, TCK, and the JTAG state machine
675 * - or else more directly, using TRST
677 * TAP_RESET should be invisible to non-debug parts of the system.
680 LOG_DEBUG("JTAG reset with TLR instead of TRST");
681 jtag_set_end_state(TAP_RESET
);
684 } else if (jtag_trst
!= new_trst
) {
685 jtag_trst
= new_trst
;
687 /* we just asserted nTRST, so we're now in TAP_RESET;
688 * inform possible listeners about this
690 * REVISIT asserting TRST is less significant than
691 * being in TAP_RESET ... both entries (TRST, TLR)
692 * should trigger a callback.
694 LOG_DEBUG("TRST line asserted");
695 tap_set_state(TAP_RESET
);
696 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
698 LOG_DEBUG("TRST line released");
699 if (jtag_ntrst_delay
)
700 jtag_add_sleep(jtag_ntrst_delay
* 1000);
707 tap_state_t
jtag_set_end_state(tap_state_t state
)
709 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
711 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
714 if (state
!= TAP_INVALID
)
715 cmd_queue_end_state
= state
;
716 return cmd_queue_end_state
;
719 tap_state_t
jtag_get_end_state(void)
721 return cmd_queue_end_state
;
724 void jtag_add_sleep(uint32_t us
)
726 /// @todo Here, keep_alive() appears to be a layering violation!!!
728 jtag_set_error(interface_jtag_add_sleep(us
));
731 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
732 uint8_t *in_check_mask
, int num_bits
)
734 int retval
= ERROR_OK
;
736 int compare_failed
= 0;
739 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
741 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
743 if (compare_failed
) {
744 char *captured_str
, *in_check_value_str
;
745 int bits
= (num_bits
> DEBUG_JTAG_IOZ
)
749 /* NOTE: we've lost diagnostic context here -- 'which tap' */
751 captured_str
= buf_to_str(captured
, bits
, 16);
752 in_check_value_str
= buf_to_str(in_check_value
, bits
, 16);
754 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
756 LOG_WARNING(" check_value: 0x%s", in_check_value_str
);
759 free(in_check_value_str
);
762 char *in_check_mask_str
;
764 in_check_mask_str
= buf_to_str(in_check_mask
, bits
, 16);
765 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str
);
766 free(in_check_mask_str
);
769 retval
= ERROR_JTAG_QUEUE_FAILED
;
774 void jtag_check_value_mask(scan_field_t
*field
, uint8_t *value
, uint8_t *mask
)
776 assert(field
->in_value
!= NULL
);
780 /* no checking to do */
784 jtag_execute_queue_noclear();
786 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
787 jtag_set_error(retval
);
792 int default_interface_jtag_execute_queue(void)
796 LOG_ERROR("No JTAG interface configured yet. "
797 "Issue 'init' command in startup scripts "
798 "before communicating with targets.");
802 return jtag
->execute_queue();
805 void jtag_execute_queue_noclear(void)
807 jtag_flush_queue_count
++;
808 jtag_set_error(interface_jtag_execute_queue());
811 int jtag_get_flush_queue_count(void)
813 return jtag_flush_queue_count
;
816 int jtag_execute_queue(void)
818 jtag_execute_queue_noclear();
819 return jtag_error_clear();
822 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
824 jtag_tap_t
*tap
= priv
;
828 if (event
== JTAG_TRST_ASSERTED
)
830 tap
->enabled
= !tap
->disabled_after_reset
;
832 /* current instruction is either BYPASS or IDCODE */
833 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
840 void jtag_sleep(uint32_t us
)
842 alive_sleep(us
/1000);
845 /// maximum number of JTAG devices expected in the chain
846 #define JTAG_MAX_CHAIN_SIZE 20
848 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
849 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
850 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
852 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
854 scan_field_t field
= {
856 .num_bits
= num_idcode
* 32,
857 .out_value
= idcode_buffer
,
858 .in_value
= idcode_buffer
,
861 // initialize to the end of chain ID value
862 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
863 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
865 jtag_add_plain_dr_scan(1, &field
, TAP_DRPAUSE
);
867 return jtag_execute_queue();
870 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
872 uint8_t zero_check
= 0x0;
873 uint8_t one_check
= 0xff;
875 for (unsigned i
= 0; i
< count
* 4; i
++)
877 zero_check
|= idcodes
[i
];
878 one_check
&= idcodes
[i
];
881 /* if there wasn't a single non-zero bit or if all bits were one,
882 * the scan is not valid */
883 if (zero_check
== 0x00 || one_check
== 0xff)
885 LOG_ERROR("JTAG communication failure: check connection, "
886 "JTAG interface, target power etc.");
892 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
893 const char *name
, uint32_t idcode
)
895 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
896 "JTAG tap: %s %16.16s: 0x%08x "
897 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
899 (unsigned int)idcode
,
900 (unsigned int)EXTRACT_MFG(idcode
),
901 (unsigned int)EXTRACT_PART(idcode
),
902 (unsigned int)EXTRACT_VER(idcode
));
905 static bool jtag_idcode_is_final(uint32_t idcode
)
907 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
911 * This helper checks that remaining bits in the examined chain data are
912 * all as expected, but a single JTAG device requires only 64 bits to be
913 * read back correctly. This can help identify and diagnose problems
914 * with the JTAG chain earlier, gives more helpful/explicit error messages.
916 static void jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
918 bool triggered
= false;
919 for (; count
< max
- 31; count
+= 32)
921 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
922 // do not trigger the warning if the data looks good
923 if (!triggered
&& jtag_idcode_is_final(idcode
))
925 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
926 count
, (unsigned int)idcode
);
931 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
933 if (0 == tap
->expected_ids_cnt
)
935 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
937 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
938 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
943 /* Loop over the expected identification codes and test for a match */
945 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
947 if (tap
->idcode
== tap
->expected_ids
[ii
])
951 /* If none of the expected ids matched, log an error */
952 if (ii
!= tap
->expected_ids_cnt
)
954 LOG_DEBUG("JTAG Tap/device matched");
957 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
958 tap
->dotted_name
, tap
->idcode
);
959 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
962 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
963 ii
+ 1, tap
->expected_ids_cnt
);
964 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
965 tap
->dotted_name
, tap
->expected_ids
[ii
]);
970 /* Try to examine chain layout according to IEEE 1149.1 §12
972 static int jtag_examine_chain(void)
974 uint8_t idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
975 unsigned device_count
= 0;
977 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
979 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
980 return ERROR_JTAG_INIT_FAILED
;
982 /* point at the 1st tap */
983 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
986 LOG_ERROR("JTAG: No taps enabled?");
987 return ERROR_JTAG_INIT_FAILED
;
990 for (unsigned bit_count
= 0;
991 tap
&& bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;
992 tap
= jtag_tap_next_enabled(tap
))
994 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
996 if ((idcode
& 1) == 0)
998 /* LSB must not be 0, this indicates a device in bypass */
999 LOG_WARNING("Tap/Device does not have IDCODE");
1001 tap
->hasidcode
= false;
1007 tap
->hasidcode
= true;
1010 * End of chain (invalid manufacturer ID) some devices, such
1011 * as AVR will output all 1's instead of TDI input value at
1014 if (jtag_idcode_is_final(idcode
))
1016 jtag_examine_chain_end(idcode_buffer
,
1017 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1021 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1022 tap
? tap
->dotted_name
: "(not-named)",
1031 tap
->idcode
= idcode
;
1033 // ensure the TAP ID does matches what was expected
1034 if (!jtag_examine_chain_match_tap(tap
))
1035 return ERROR_JTAG_INIT_FAILED
;
1038 /* see if number of discovered devices matches configuration */
1039 if (device_count
!= jtag_tap_count_enabled())
1041 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1042 "does not match (enabled) configuration (%i), total taps: %d",
1043 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1044 LOG_ERROR("check the config file and ensure proper JTAG communication"
1045 " (connections, speed, ...)");
1046 return ERROR_JTAG_INIT_FAILED
;
1052 int jtag_validate_chain(void)
1055 int total_ir_length
= 0;
1056 uint8_t *ir_test
= NULL
;
1061 total_ir_length
= 0;
1063 tap
= jtag_tap_next_enabled(tap
);
1067 total_ir_length
+= tap
->ir_length
;
1070 total_ir_length
+= 2;
1071 ir_test
= malloc(CEIL(total_ir_length
, 8));
1072 buf_set_ones(ir_test
, total_ir_length
);
1075 field
.num_bits
= total_ir_length
;
1076 field
.out_value
= ir_test
;
1077 field
.in_value
= ir_test
;
1080 jtag_add_plain_ir_scan(1, &field
, TAP_IRPAUSE
);
1084 retval
= jtag_execute_queue();
1085 if (retval
!= ERROR_OK
)
1092 tap
= jtag_tap_next_enabled(tap
);
1097 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1098 /* Only fail this check if we have IDCODE for this device */
1099 if ((val
!= 0x1)&&(tap
->hasidcode
))
1101 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1102 LOG_ERROR("Could not validate JTAG scan chain, IR mismatch, scan returned 0x%s. tap=%s pos=%d expected 0x1 got %0x", cbuf
, jtag_tap_name(tap
), chain_pos
, val
);
1105 return ERROR_JTAG_INIT_FAILED
;
1107 chain_pos
+= tap
->ir_length
;
1110 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1113 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1114 LOG_ERROR("Could not validate end of JTAG scan chain, IR mismatch, scan returned 0x%s. pos=%d expected 0x3 got %0x", cbuf
, chain_pos
, val
);
1117 return ERROR_JTAG_INIT_FAILED
;
1126 void jtag_tap_init(jtag_tap_t
*tap
)
1128 assert(0 != tap
->ir_length
);
1130 tap
->expected
= malloc(tap
->ir_length
);
1131 tap
->expected_mask
= malloc(tap
->ir_length
);
1132 tap
->cur_instr
= malloc(tap
->ir_length
);
1134 /// @todo cope sanely with ir_length bigger than 32 bits
1135 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1136 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1137 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1139 // place TAP in bypass mode
1141 // register the reset callback for the TAP
1142 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1144 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1145 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1146 tap
->abs_chain_position
, tap
->ir_length
,
1147 (unsigned int)(tap
->ir_capture_value
), (unsigned int)(tap
->ir_capture_mask
));
1151 void jtag_tap_free(jtag_tap_t
*tap
)
1153 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1155 /// @todo is anything missing? no memory leaks please
1156 free((void *)tap
->expected_ids
);
1157 free((void *)tap
->chip
);
1158 free((void *)tap
->tapname
);
1159 free((void *)tap
->dotted_name
);
1163 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1168 if (!jtag_interface
)
1170 /* nothing was previously specified by "interface" command */
1171 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1172 return ERROR_JTAG_INVALID_INTERFACE
;
1175 jtag
= jtag_interface
;
1176 if (jtag_interface
->init() != ERROR_OK
)
1179 return ERROR_JTAG_INIT_FAILED
;
1182 int requested_khz
= jtag_get_speed_khz();
1183 int actual_khz
= requested_khz
;
1184 int retval
= jtag_get_speed_readable(&actual_khz
);
1185 if (ERROR_OK
!= retval
)
1186 LOG_INFO("interface specific clock speed value %d", jtag_get_speed());
1187 else if (actual_khz
)
1189 if ((CLOCK_MODE_RCLK
== clock_mode
)
1190 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
))
1192 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1196 LOG_INFO("clock speed %d kHz", actual_khz
);
1199 LOG_INFO("RCLK (adaptive clock speed)");
1204 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1209 LOG_DEBUG("Init JTAG chain");
1211 tap
= jtag_tap_next_enabled(NULL
);
1213 LOG_ERROR("There are no enabled taps?");
1214 return ERROR_JTAG_INIT_FAILED
;
1218 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1221 /* examine chain first, as this could discover the real chain layout */
1222 if (jtag_examine_chain() != ERROR_OK
)
1224 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1227 if (jtag_validate_chain() != ERROR_OK
)
1229 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1235 int jtag_interface_quit(void)
1237 if (!jtag
|| !jtag
->quit
)
1240 // close the JTAG interface
1241 int result
= jtag
->quit();
1242 if (ERROR_OK
!= result
)
1243 LOG_ERROR("failed: %d", result
);
1249 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1253 if ((retval
= jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1256 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / TLR");
1258 /* Reset can happen after a power cycle.
1260 * Ideally we would only assert TRST or run TLR before the target reset.
1262 * However w/srst_pulls_trst, trst is asserted together with the target
1263 * reset whether we want it or not.
1265 * NB! Some targets have JTAG circuitry disabled until a
1266 * trst & srst has been asserted.
1268 * NB! here we assume nsrst/ntrst delay are sufficient!
1270 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1273 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1274 if (jtag_reset_config
& RESET_HAS_SRST
)
1276 jtag_add_reset(1, 1);
1277 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1278 jtag_add_reset(0, 1);
1280 jtag_add_reset(0, 0);
1281 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1284 /* Check that we can communication on the JTAG chain + eventually we want to
1285 * be able to perform enumeration only after OpenOCD has started
1286 * telnet and GDB server
1288 * That would allow users to more easily perform any magic they need to before
1291 return jtag_init_inner(cmd_ctx
);
1294 int jtag_init(struct command_context_s
*cmd_ctx
)
1297 if ((retval
= jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1299 if (jtag_init_inner(cmd_ctx
) == ERROR_OK
)
1303 return jtag_init_reset(cmd_ctx
);
1306 unsigned jtag_get_speed_khz(void)
1311 static int jtag_khz_to_speed(unsigned khz
, int* speed
)
1313 LOG_DEBUG("convert khz to interface specific speed value");
1317 LOG_DEBUG("have interface set up");
1319 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1320 if (ERROR_OK
!= retval
)
1324 *speed
= speed_div1
;
1329 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int* speed
)
1331 int retval
= jtag_khz_to_speed(0, speed
);
1332 if ((ERROR_OK
!= retval
) && fallback_speed_khz
)
1334 LOG_DEBUG("trying fallback speed...");
1335 retval
= jtag_khz_to_speed(fallback_speed_khz
, speed
);
1340 static int jtag_set_speed(int speed
)
1343 /* this command can be called during CONFIG,
1344 * in which case jtag isn't initialized */
1345 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1348 int jtag_config_speed(int speed
)
1350 LOG_DEBUG("handle jtag speed");
1351 clock_mode
= CLOCK_MODE_SPEED
;
1352 return jtag_set_speed(speed
);
1355 int jtag_config_khz(unsigned khz
)
1357 LOG_DEBUG("handle jtag khz");
1358 clock_mode
= CLOCK_MODE_KHZ
;
1360 int retval
= jtag_khz_to_speed(khz
, &speed
);
1361 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1364 int jtag_config_rclk(unsigned fallback_speed_khz
)
1366 LOG_DEBUG("handle jtag rclk");
1367 clock_mode
= CLOCK_MODE_RCLK
;
1368 rclk_fallback_speed_khz
= fallback_speed_khz
;
1370 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1371 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1374 int jtag_get_speed(void)
1379 case CLOCK_MODE_SPEED
:
1382 case CLOCK_MODE_KHZ
:
1383 jtag_khz_to_speed(jtag_get_speed_khz(), &speed
);
1385 case CLOCK_MODE_RCLK
:
1386 jtag_rclk_to_speed(rclk_fallback_speed_khz
, &speed
);
1389 LOG_ERROR("BUG: unknown jtag clock mode");
1396 int jtag_get_speed_readable(int *khz
)
1398 return jtag
? jtag
->speed_div(jtag_get_speed(), khz
) : ERROR_OK
;
1401 void jtag_set_verify(bool enable
)
1403 jtag_verify
= enable
;
1406 bool jtag_will_verify()
1411 void jtag_set_verify_capture_ir(bool enable
)
1413 jtag_verify_capture_ir
= enable
;
1416 bool jtag_will_verify_capture_ir()
1418 return jtag_verify_capture_ir
;
1421 int jtag_power_dropout(int *dropout
)
1423 return jtag
->power_dropout(dropout
);
1426 int jtag_srst_asserted(int *srst_asserted
)
1428 return jtag
->srst_asserted(srst_asserted
);
1431 enum reset_types
jtag_get_reset_config(void)
1433 return jtag_reset_config
;
1435 void jtag_set_reset_config(enum reset_types type
)
1437 jtag_reset_config
= type
;
1440 int jtag_get_trst(void)
1444 int jtag_get_srst(void)
1449 void jtag_set_nsrst_delay(unsigned delay
)
1451 jtag_nsrst_delay
= delay
;
1453 unsigned jtag_get_nsrst_delay(void)
1455 return jtag_nsrst_delay
;
1457 void jtag_set_ntrst_delay(unsigned delay
)
1459 jtag_ntrst_delay
= delay
;
1461 unsigned jtag_get_ntrst_delay(void)
1463 return jtag_ntrst_delay
;
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)