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
] = "TAP reset",
64 [JTAG_TAP_EVENT_ENABLE
] = "TAP enabled",
65 [JTAG_TAP_EVENT_POST_RESET
] = "TAP 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
);
474 assert(end_state
!= TAP_INVALID
);
476 cmd_queue_cur_state
= end_state
;
478 interface_jtag_add_dr_out(tap
,
479 num_fields
, num_bits
, value
,
483 void jtag_add_tlr(void)
485 jtag_prelude(TAP_RESET
);
486 jtag_set_error(interface_jtag_add_tlr());
488 /* NOTE: order here matches TRST path in jtag_add_reset() */
489 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
493 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
495 tap_state_t cur_state
= cmd_queue_cur_state
;
497 /* the last state has to be a stable state */
498 if (!tap_is_state_stable(path
[num_states
- 1]))
500 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
501 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
505 for (int i
= 0; i
< num_states
; i
++)
507 if (path
[i
] == TAP_RESET
)
509 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
510 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
514 if (tap_state_transition(cur_state
, true) != path
[i
]
515 && tap_state_transition(cur_state
, false) != path
[i
])
517 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
518 tap_state_name(cur_state
), tap_state_name(path
[i
]));
519 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
527 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
528 cmd_queue_cur_state
= path
[num_states
- 1];
531 int jtag_add_statemove(tap_state_t goal_state
)
533 tap_state_t cur_state
= cmd_queue_cur_state
;
535 LOG_DEBUG("cur_state=%s goal_state=%s",
536 tap_state_name(cur_state
),
537 tap_state_name(goal_state
));
540 if (goal_state
== cur_state
)
541 ; /* nothing to do */
542 else if (goal_state
== TAP_RESET
)
546 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
))
548 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
549 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
550 tap_state_t moves
[8];
551 assert(tms_count
< DIM(moves
));
553 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1)
555 bool bit
= tms_bits
& 1;
557 cur_state
= tap_state_transition(cur_state
, bit
);
558 moves
[i
] = cur_state
;
561 jtag_add_pathmove(tms_count
, moves
);
563 else if (tap_state_transition(cur_state
, true) == goal_state
564 || tap_state_transition(cur_state
, false) == goal_state
)
566 jtag_add_pathmove(1, &goal_state
);
575 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
578 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
582 void jtag_add_clocks(int num_cycles
)
584 if (!tap_is_state_stable(cmd_queue_cur_state
))
586 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
587 tap_state_name(cmd_queue_cur_state
));
588 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
595 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
599 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
601 int trst_with_tlr
= 0;
605 /* Without SRST, we must use target-specific JTAG operations
606 * on each target; callers should not be requesting SRST when
607 * that signal doesn't exist.
609 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
610 * can kick in even if the JTAG adapter can't drive TRST.
613 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
614 LOG_ERROR("BUG: can't assert SRST");
615 jtag_set_error(ERROR_FAIL
);
618 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
619 && !req_tlr_or_trst
) {
620 LOG_ERROR("BUG: can't assert only SRST");
621 jtag_set_error(ERROR_FAIL
);
627 /* JTAG reset (entry to TAP_RESET state) can always be achieved
628 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
629 * state first. TRST accelerates it, and bypasses those states.
631 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
632 * can kick in even if the JTAG adapter can't drive SRST.
634 if (req_tlr_or_trst
) {
635 if (!(jtag_reset_config
& RESET_HAS_TRST
))
637 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
644 /* Maybe change TRST and/or SRST signal state */
645 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
648 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
649 if (retval
!= ERROR_OK
)
650 jtag_set_error(retval
);
652 retval
= jtag_execute_queue();
654 if (retval
!= ERROR_OK
) {
655 LOG_ERROR("TRST/SRST error %d", retval
);
660 /* SRST resets everything hooked up to that signal */
661 if (jtag_srst
!= new_srst
) {
662 jtag_srst
= new_srst
;
664 LOG_DEBUG("SRST line asserted");
666 LOG_DEBUG("SRST line released");
667 if (jtag_nsrst_delay
)
668 jtag_add_sleep(jtag_nsrst_delay
* 1000);
672 /* Maybe enter the JTAG TAP_RESET state ...
673 * - using only TMS, TCK, and the JTAG state machine
674 * - or else more directly, using TRST
676 * TAP_RESET should be invisible to non-debug parts of the system.
679 LOG_DEBUG("JTAG reset with TLR instead of TRST");
680 jtag_set_end_state(TAP_RESET
);
683 } else if (jtag_trst
!= new_trst
) {
684 jtag_trst
= new_trst
;
686 LOG_DEBUG("TRST line asserted");
687 tap_set_state(TAP_RESET
);
689 LOG_DEBUG("TRST line released");
690 if (jtag_ntrst_delay
)
691 jtag_add_sleep(jtag_ntrst_delay
* 1000);
693 /* We just asserted nTRST, so we're now in TAP_RESET.
694 * Inform possible listeners about this, now that
695 * JTAG instructions and data can be shifted. This
696 * sequence must match jtag_add_tlr().
698 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
704 tap_state_t
jtag_set_end_state(tap_state_t state
)
706 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
708 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
711 if (state
!= TAP_INVALID
)
712 cmd_queue_end_state
= state
;
713 return cmd_queue_end_state
;
716 tap_state_t
jtag_get_end_state(void)
718 return cmd_queue_end_state
;
721 void jtag_add_sleep(uint32_t us
)
723 /// @todo Here, keep_alive() appears to be a layering violation!!!
725 jtag_set_error(interface_jtag_add_sleep(us
));
728 static int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
,
729 uint8_t *in_check_mask
, int num_bits
)
731 int retval
= ERROR_OK
;
733 int compare_failed
= 0;
736 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
738 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
740 if (compare_failed
) {
741 char *captured_str
, *in_check_value_str
;
742 int bits
= (num_bits
> DEBUG_JTAG_IOZ
)
746 /* NOTE: we've lost diagnostic context here -- 'which tap' */
748 captured_str
= buf_to_str(captured
, bits
, 16);
749 in_check_value_str
= buf_to_str(in_check_value
, bits
, 16);
751 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
753 LOG_WARNING(" check_value: 0x%s", in_check_value_str
);
756 free(in_check_value_str
);
759 char *in_check_mask_str
;
761 in_check_mask_str
= buf_to_str(in_check_mask
, bits
, 16);
762 LOG_WARNING(" check_mask: 0x%s", in_check_mask_str
);
763 free(in_check_mask_str
);
766 retval
= ERROR_JTAG_QUEUE_FAILED
;
771 void jtag_check_value_mask(scan_field_t
*field
, uint8_t *value
, uint8_t *mask
)
773 assert(field
->in_value
!= NULL
);
777 /* no checking to do */
781 jtag_execute_queue_noclear();
783 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
784 jtag_set_error(retval
);
789 int default_interface_jtag_execute_queue(void)
793 LOG_ERROR("No JTAG interface configured yet. "
794 "Issue 'init' command in startup scripts "
795 "before communicating with targets.");
799 return jtag
->execute_queue();
802 void jtag_execute_queue_noclear(void)
804 jtag_flush_queue_count
++;
805 jtag_set_error(interface_jtag_execute_queue());
808 int jtag_get_flush_queue_count(void)
810 return jtag_flush_queue_count
;
813 int jtag_execute_queue(void)
815 jtag_execute_queue_noclear();
816 return jtag_error_clear();
819 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
821 jtag_tap_t
*tap
= priv
;
823 if (event
== JTAG_TRST_ASSERTED
)
825 tap
->enabled
= !tap
->disabled_after_reset
;
827 /* current instruction is either BYPASS or IDCODE */
828 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
835 void jtag_sleep(uint32_t us
)
837 alive_sleep(us
/1000);
840 /* Maximum number of enabled JTAG devices we expect in the scan chain,
841 * plus one (to detect garbage at the end). Devices that don't support
842 * IDCODE take up fewer bits, possibly allowing a few more devices.
844 #define JTAG_MAX_CHAIN_SIZE 20
846 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
847 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
848 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
850 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
851 * know that no valid TAP will have it as an IDCODE value.
853 #define END_OF_CHAIN_FLAG 0x000000ff
855 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
857 scan_field_t field
= {
859 .num_bits
= num_idcode
* 32,
860 .out_value
= idcode_buffer
,
861 .in_value
= idcode_buffer
,
864 // initialize to the end of chain ID value
865 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
866 buf_set_u32(idcode_buffer
, i
* 32, 32, END_OF_CHAIN_FLAG
);
868 jtag_add_plain_dr_scan(1, &field
, TAP_DRPAUSE
);
870 return jtag_execute_queue();
873 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
875 uint8_t zero_check
= 0x0;
876 uint8_t one_check
= 0xff;
878 for (unsigned i
= 0; i
< count
* 4; i
++)
880 zero_check
|= idcodes
[i
];
881 one_check
&= idcodes
[i
];
884 /* if there wasn't a single non-zero bit or if all bits were one,
885 * the scan is not valid */
886 if (zero_check
== 0x00 || one_check
== 0xff)
888 LOG_ERROR("JTAG communication failure: check connection, "
889 "JTAG interface, target power etc.");
895 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
896 const char *name
, uint32_t idcode
)
898 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
899 "JTAG tap: %s %16.16s: 0x%08x "
900 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
902 (unsigned int)idcode
,
903 (unsigned int)EXTRACT_MFG(idcode
),
904 (unsigned int)EXTRACT_PART(idcode
),
905 (unsigned int)EXTRACT_VER(idcode
));
908 static bool jtag_idcode_is_final(uint32_t idcode
)
911 * Some devices, such as AVR8, will output all 1's instead
912 * of TDI input value at end of chain. Allow those values
913 * instead of failing.
915 return idcode
== END_OF_CHAIN_FLAG
|| idcode
== 0xFFFFFFFF;
919 * This helper checks that remaining bits in the examined chain data are
920 * all as expected, but a single JTAG device requires only 64 bits to be
921 * read back correctly. This can help identify and diagnose problems
922 * with the JTAG chain earlier, gives more helpful/explicit error messages.
923 * Returns TRUE iff garbage was found.
925 static bool jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
927 bool triggered
= false;
928 for (; count
< max
- 31; count
+= 32)
930 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
931 // do not trigger the warning if the data looks good
932 if (!triggered
&& jtag_idcode_is_final(idcode
))
934 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
935 count
, (unsigned int)idcode
);
941 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
943 /* ignore expected BYPASS codes; warn otherwise */
944 if (0 == tap
->expected_ids_cnt
&& !tap
->idcode
)
947 /* Loop over the expected identification codes and test for a match */
949 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
951 if (tap
->idcode
== tap
->expected_ids
[ii
])
955 /* If none of the expected ids matched, log an error */
956 jtag_examine_chain_display(LOG_LVL_ERROR
, "UNEXPECTED",
957 tap
->dotted_name
, tap
->idcode
);
958 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
961 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
962 ii
+ 1, tap
->expected_ids_cnt
);
963 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
964 tap
->dotted_name
, tap
->expected_ids
[ii
]);
969 /* Try to examine chain layout according to IEEE 1149.1 §12
970 * This is called a "blind interrogation" of the scan chain.
972 static int jtag_examine_chain(void)
974 uint8_t idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
977 /* DR scan to collect BYPASS or IDCODE register contents.
978 * Then make sure the scan data has both ones and zeroes.
980 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
981 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
982 return ERROR_JTAG_INIT_FAILED
;
984 /* point at the 1st tap */
985 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
988 LOG_ERROR("JTAG: No taps enabled?");
989 return ERROR_JTAG_INIT_FAILED
;
993 tap
&& bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;
994 tap
= jtag_tap_next_enabled(tap
))
996 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
998 if ((idcode
& 1) == 0)
1000 /* LSB must not be 0, this indicates a device in bypass */
1001 LOG_WARNING("TAP %s does not have IDCODE",
1004 tap
->hasidcode
= false;
1010 /* Friendly devices support IDCODE */
1011 tap
->hasidcode
= true;
1012 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1013 tap
->dotted_name
, idcode
);
1017 tap
->idcode
= idcode
;
1019 // ensure the TAP ID does matches what was expected
1020 if (!jtag_examine_chain_match_tap(tap
))
1021 return ERROR_JTAG_INIT_FAILED
;
1024 /* Fail if too many TAPs were enabled for us to verify them all. */
1026 LOG_ERROR("Too many TAPs enabled; '%s' ignored.",
1028 return ERROR_JTAG_INIT_FAILED
;
1031 /* After those IDCODE or BYPASS register values should be
1032 * only the data we fed into the scan chain.
1034 if (jtag_examine_chain_end(idcode_buffer
, bit_count
,
1035 8 * sizeof(idcode_buffer
))) {
1036 LOG_ERROR("double-check your JTAG setup (interface, "
1037 "speed, TAPs, ...)");
1038 return ERROR_JTAG_INIT_FAILED
;
1045 * Validate the date loaded by entry to the Capture-IR state, to help
1046 * find errors related to scan chain configuration (wrong IR lengths)
1049 static int jtag_validate_ircapture(void)
1052 int total_ir_length
= 0;
1053 uint8_t *ir_test
= NULL
;
1058 total_ir_length
= 0;
1060 tap
= jtag_tap_next_enabled(tap
);
1064 total_ir_length
+= tap
->ir_length
;
1067 total_ir_length
+= 2;
1069 ir_test
= malloc(CEIL(total_ir_length
, 8));
1070 if (ir_test
== NULL
)
1073 buf_set_ones(ir_test
, total_ir_length
);
1076 field
.num_bits
= total_ir_length
;
1077 field
.out_value
= ir_test
;
1078 field
.in_value
= ir_test
;
1081 jtag_add_plain_ir_scan(1, &field
, TAP_IRPAUSE
);
1085 retval
= jtag_execute_queue();
1086 if (retval
!= ERROR_OK
)
1093 tap
= jtag_tap_next_enabled(tap
);
1098 /* Validate the two LSBs, which must be 01 per JTAG spec.
1099 * REVISIT we might be able to verify some MSBs too, using
1100 * ircapture/irmask attributes.
1102 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1104 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1106 LOG_ERROR("%s: IR capture error; saw 0x%s not 0x..1",
1107 jtag_tap_name(tap
), cbuf
);
1109 /* Fail only if we have IDCODE for this device.
1110 * REVISIT -- why not fail-always?
1112 if (tap
->hasidcode
) {
1115 return ERROR_JTAG_INIT_FAILED
;
1118 chain_pos
+= tap
->ir_length
;
1121 /* verify the '11' sentinel we wrote is returned at the end */
1122 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1125 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1127 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1131 return ERROR_JTAG_INIT_FAILED
;
1140 void jtag_tap_init(jtag_tap_t
*tap
)
1142 assert(0 != tap
->ir_length
);
1144 /// @todo fix, this allocates one byte per bit for all three fields!
1145 tap
->expected
= malloc(tap
->ir_length
);
1146 tap
->expected_mask
= malloc(tap
->ir_length
);
1147 tap
->cur_instr
= malloc(tap
->ir_length
);
1149 /// @todo cope sanely with ir_length bigger than 32 bits
1150 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1151 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1152 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1154 // place TAP in bypass mode
1156 // register the reset callback for the TAP
1157 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1159 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1160 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1161 tap
->abs_chain_position
, tap
->ir_length
,
1162 (unsigned) tap
->ir_capture_value
,
1163 (unsigned) tap
->ir_capture_mask
);
1167 void jtag_tap_free(jtag_tap_t
*tap
)
1169 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1171 /// @todo is anything missing? no memory leaks please
1172 free((void *)tap
->expected
);
1173 free((void *)tap
->expected_ids
);
1174 free((void *)tap
->chip
);
1175 free((void *)tap
->tapname
);
1176 free((void *)tap
->dotted_name
);
1180 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1185 if (!jtag_interface
)
1187 /* nothing was previously specified by "interface" command */
1188 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1189 return ERROR_JTAG_INVALID_INTERFACE
;
1192 jtag
= jtag_interface
;
1193 if (jtag_interface
->init() != ERROR_OK
)
1196 return ERROR_JTAG_INIT_FAILED
;
1199 int requested_khz
= jtag_get_speed_khz();
1200 int actual_khz
= requested_khz
;
1201 int retval
= jtag_get_speed_readable(&actual_khz
);
1202 if (ERROR_OK
!= retval
)
1203 LOG_INFO("interface specific clock speed value %d", jtag_get_speed());
1204 else if (actual_khz
)
1206 if ((CLOCK_MODE_RCLK
== clock_mode
)
1207 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
))
1209 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1213 LOG_INFO("clock speed %d kHz", actual_khz
);
1216 LOG_INFO("RCLK (adaptive clock speed)");
1221 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1226 LOG_DEBUG("Init JTAG chain");
1228 tap
= jtag_tap_next_enabled(NULL
);
1230 LOG_ERROR("There are no enabled taps?");
1231 return ERROR_JTAG_INIT_FAILED
;
1235 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1238 /* examine chain first, as this could discover the real chain layout */
1239 if (jtag_examine_chain() != ERROR_OK
)
1241 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1244 if (jtag_validate_ircapture() != ERROR_OK
)
1246 LOG_WARNING("Errors during IR capture, continuing anyway...");
1252 int jtag_interface_quit(void)
1254 if (!jtag
|| !jtag
->quit
)
1257 // close the JTAG interface
1258 int result
= jtag
->quit();
1259 if (ERROR_OK
!= result
)
1260 LOG_ERROR("failed: %d", result
);
1266 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1270 if ((retval
= jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1273 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / TLR");
1275 /* Reset can happen after a power cycle.
1277 * Ideally we would only assert TRST or run TLR before the target reset.
1279 * However w/srst_pulls_trst, trst is asserted together with the target
1280 * reset whether we want it or not.
1282 * NB! Some targets have JTAG circuitry disabled until a
1283 * trst & srst has been asserted.
1285 * NB! here we assume nsrst/ntrst delay are sufficient!
1287 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1290 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1291 if (jtag_reset_config
& RESET_HAS_SRST
)
1293 jtag_add_reset(1, 1);
1294 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1295 jtag_add_reset(0, 1);
1297 jtag_add_reset(0, 0);
1298 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1301 /* Check that we can communication on the JTAG chain + eventually we want to
1302 * be able to perform enumeration only after OpenOCD has started
1303 * telnet and GDB server
1305 * That would allow users to more easily perform any magic they need to before
1308 return jtag_init_inner(cmd_ctx
);
1311 int jtag_init(struct command_context_s
*cmd_ctx
)
1314 if ((retval
= jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1316 if (jtag_init_inner(cmd_ctx
) == ERROR_OK
)
1320 return jtag_init_reset(cmd_ctx
);
1323 unsigned jtag_get_speed_khz(void)
1328 static int jtag_khz_to_speed(unsigned khz
, int* speed
)
1330 LOG_DEBUG("convert khz to interface specific speed value");
1334 LOG_DEBUG("have interface set up");
1336 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1337 if (ERROR_OK
!= retval
)
1341 *speed
= speed_div1
;
1346 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int* speed
)
1348 int retval
= jtag_khz_to_speed(0, speed
);
1349 if ((ERROR_OK
!= retval
) && fallback_speed_khz
)
1351 LOG_DEBUG("trying fallback speed...");
1352 retval
= jtag_khz_to_speed(fallback_speed_khz
, speed
);
1357 static int jtag_set_speed(int speed
)
1360 /* this command can be called during CONFIG,
1361 * in which case jtag isn't initialized */
1362 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1365 int jtag_config_speed(int speed
)
1367 LOG_DEBUG("handle jtag speed");
1368 clock_mode
= CLOCK_MODE_SPEED
;
1369 return jtag_set_speed(speed
);
1372 int jtag_config_khz(unsigned khz
)
1374 LOG_DEBUG("handle jtag khz");
1375 clock_mode
= CLOCK_MODE_KHZ
;
1377 int retval
= jtag_khz_to_speed(khz
, &speed
);
1378 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1381 int jtag_config_rclk(unsigned fallback_speed_khz
)
1383 LOG_DEBUG("handle jtag rclk");
1384 clock_mode
= CLOCK_MODE_RCLK
;
1385 rclk_fallback_speed_khz
= fallback_speed_khz
;
1387 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1388 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1391 int jtag_get_speed(void)
1396 case CLOCK_MODE_SPEED
:
1399 case CLOCK_MODE_KHZ
:
1400 jtag_khz_to_speed(jtag_get_speed_khz(), &speed
);
1402 case CLOCK_MODE_RCLK
:
1403 jtag_rclk_to_speed(rclk_fallback_speed_khz
, &speed
);
1406 LOG_ERROR("BUG: unknown jtag clock mode");
1413 int jtag_get_speed_readable(int *khz
)
1415 return jtag
? jtag
->speed_div(jtag_get_speed(), khz
) : ERROR_OK
;
1418 void jtag_set_verify(bool enable
)
1420 jtag_verify
= enable
;
1423 bool jtag_will_verify()
1428 void jtag_set_verify_capture_ir(bool enable
)
1430 jtag_verify_capture_ir
= enable
;
1433 bool jtag_will_verify_capture_ir()
1435 return jtag_verify_capture_ir
;
1438 int jtag_power_dropout(int *dropout
)
1440 return jtag
->power_dropout(dropout
);
1443 int jtag_srst_asserted(int *srst_asserted
)
1445 return jtag
->srst_asserted(srst_asserted
);
1448 enum reset_types
jtag_get_reset_config(void)
1450 return jtag_reset_config
;
1452 void jtag_set_reset_config(enum reset_types type
)
1454 jtag_reset_config
= type
;
1457 int jtag_get_trst(void)
1461 int jtag_get_srst(void)
1466 void jtag_set_nsrst_delay(unsigned delay
)
1468 jtag_nsrst_delay
= delay
;
1470 unsigned jtag_get_nsrst_delay(void)
1472 return jtag_nsrst_delay
;
1474 void jtag_set_ntrst_delay(unsigned delay
)
1476 jtag_ntrst_delay
= delay
;
1478 unsigned jtag_get_ntrst_delay(void)
1480 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)