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_DISABLE
] = "TAP disabled",
69 * JTAG adapters must initialize with TRST and SRST de-asserted
70 * (they're negative logic, so that means *high*)
72 static int jtag_trst
= 0;
73 static int jtag_srst
= 0;
76 * List all TAPs that have been created.
78 static jtag_tap_t
*__jtag_all_taps
= NULL
;
80 * The number of TAPs in the __jtag_all_taps list, used to track the
81 * assigned chain position to new TAPs
83 static unsigned jtag_num_taps
= 0;
85 static enum reset_types jtag_reset_config
= RESET_NONE
;
86 static tap_state_t cmd_queue_end_state
= TAP_RESET
;
87 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
89 static bool jtag_verify_capture_ir
= true;
90 static int jtag_verify
= 1;
92 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
93 static int jtag_nsrst_delay
= 0; /* default to no nSRST delay */
94 static int jtag_ntrst_delay
= 0; /* default to no nTRST delay */
96 typedef struct jtag_event_callback_s
98 jtag_event_handler_t callback
;
100 struct jtag_event_callback_s
* next
;
101 } jtag_event_callback_t
;
103 /* callbacks to inform high-level handlers about JTAG state changes */
104 static jtag_event_callback_t
*jtag_event_callbacks
;
107 static int speed_khz
= 0;
108 /* speed to fallback to when RCLK is requested but not supported */
109 static int rclk_fallback_speed_khz
= 0;
110 static enum {CLOCK_MODE_SPEED
, CLOCK_MODE_KHZ
, CLOCK_MODE_RCLK
} clock_mode
;
111 static int jtag_speed
= 0;
113 static struct jtag_interface_s
*jtag
= NULL
;
116 jtag_interface_t
*jtag_interface
= NULL
;
118 void jtag_set_error(int error
)
120 if ((error
== ERROR_OK
) || (jtag_error
!= ERROR_OK
))
124 int jtag_get_error(void)
128 int jtag_error_clear(void)
130 int temp
= jtag_error
;
131 jtag_error
= ERROR_OK
;
136 jtag_tap_t
*jtag_all_taps(void)
138 return __jtag_all_taps
;
141 unsigned jtag_tap_count(void)
143 return jtag_num_taps
;
146 unsigned jtag_tap_count_enabled(void)
148 jtag_tap_t
*t
= jtag_all_taps();
159 /// Append a new TAP to the chain of all taps.
160 void jtag_tap_add(struct jtag_tap_s
*t
)
162 t
->abs_chain_position
= jtag_num_taps
++;
164 jtag_tap_t
**tap
= &__jtag_all_taps
;
166 tap
= &(*tap
)->next_tap
;
170 /* returns a pointer to the n-th device in the scan chain */
171 static inline jtag_tap_t
*jtag_tap_by_position(unsigned n
)
173 jtag_tap_t
*t
= jtag_all_taps();
181 jtag_tap_t
*jtag_tap_by_string(const char *s
)
183 /* try by name first */
184 jtag_tap_t
*t
= jtag_all_taps();
188 if (0 == strcmp(t
->dotted_name
, s
))
193 /* no tap found by name, so try to parse the name as a number */
195 if (parse_uint(s
, &n
) != ERROR_OK
)
198 /* FIXME remove this numeric fallback code late June 2010, along
199 * with all info in the User's Guide that TAPs have numeric IDs.
200 * Also update "scan_chain" output to not display the numbers.
202 t
= jtag_tap_by_position(n
);
204 LOG_WARNING("Specify TAP '%s' by name, not number %u",
210 jtag_tap_t
*jtag_tap_by_jim_obj(Jim_Interp
*interp
, Jim_Obj
*o
)
212 const char *cp
= Jim_GetString(o
, NULL
);
213 jtag_tap_t
*t
= cp
? jtag_tap_by_string(cp
) : NULL
;
217 Jim_SetResult_sprintf(interp
, "Tap '%s' could not be found", cp
);
221 jtag_tap_t
* jtag_tap_next_enabled(jtag_tap_t
* p
)
223 p
= p
? p
->next_tap
: jtag_all_taps();
233 const char *jtag_tap_name(const jtag_tap_t
*tap
)
235 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
239 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
241 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
243 if (callback
== NULL
)
245 return ERROR_INVALID_ARGUMENTS
;
250 while ((*callbacks_p
)->next
)
251 callbacks_p
= &((*callbacks_p
)->next
);
252 callbacks_p
= &((*callbacks_p
)->next
);
255 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
256 (*callbacks_p
)->callback
= callback
;
257 (*callbacks_p
)->priv
= priv
;
258 (*callbacks_p
)->next
= NULL
;
263 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
265 jtag_event_callback_t
**callbacks_p
;
266 jtag_event_callback_t
**next
;
268 if (callback
== NULL
)
270 return ERROR_INVALID_ARGUMENTS
;
273 for (callbacks_p
= &jtag_event_callbacks
;
274 *callbacks_p
!= NULL
;
277 next
= &((*callbacks_p
)->next
);
279 if ((*callbacks_p
)->priv
!= priv
)
282 if ((*callbacks_p
)->callback
== callback
)
285 *callbacks_p
= *next
;
292 int jtag_call_event_callbacks(enum jtag_event event
)
294 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
296 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
300 jtag_event_callback_t
*next
;
302 /* callback may remove itself */
303 next
= callback
->next
;
304 callback
->callback(event
, callback
->priv
);
311 static void jtag_checks(void)
313 assert(jtag_trst
== 0);
316 static void jtag_prelude(tap_state_t state
)
320 assert(state
!= TAP_INVALID
);
322 cmd_queue_cur_state
= state
;
325 void jtag_alloc_in_value32(scan_field_t
*field
)
327 interface_jtag_alloc_in_value32(field
);
330 void jtag_add_ir_scan_noverify(int in_count
, const scan_field_t
*in_fields
,
335 int retval
= interface_jtag_add_ir_scan(in_count
, in_fields
, state
);
336 jtag_set_error(retval
);
340 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
342 if (jtag_verify
&& jtag_verify_capture_ir
)
344 /* 8 x 32 bit id's is enough for all invocations */
346 for (int j
= 0; j
< in_num_fields
; j
++)
348 /* if we are to run a verification of the ir scan, we need to get the input back.
349 * We may have to allocate space if the caller didn't ask for the input back.
351 in_fields
[j
].check_value
= in_fields
[j
].tap
->expected
;
352 in_fields
[j
].check_mask
= in_fields
[j
].tap
->expected_mask
;
354 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
357 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
361 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
,
366 int retval
= interface_jtag_add_plain_ir_scan(
367 in_num_fields
, in_fields
, state
);
368 jtag_set_error(retval
);
371 void jtag_add_callback(jtag_callback1_t f
, jtag_callback_data_t data0
)
373 interface_jtag_add_callback(f
, data0
);
376 void jtag_add_callback4(jtag_callback_t f
, jtag_callback_data_t data0
,
377 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
378 jtag_callback_data_t data3
)
380 interface_jtag_add_callback4(f
, data0
, data1
, data2
, data3
);
383 int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
, uint8_t *in_check_mask
, int num_bits
);
385 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
)
387 return jtag_check_value_inner((uint8_t *)data0
, (uint8_t *)data1
, (uint8_t *)data2
, (int)data3
);
390 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
391 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
393 for (int i
= 0; i
< in_num_fields
; i
++)
395 struct scan_field_s
*field
= &in_fields
[i
];
396 field
->allocated
= 0;
398 if (field
->check_value
|| field
->in_value
)
400 interface_jtag_add_scan_check_alloc(field
);
404 jtag_add_scan(in_num_fields
, in_fields
, state
);
406 for (int i
= 0; i
< in_num_fields
; i
++)
408 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
410 /* this is synchronous for a minidriver */
411 jtag_add_callback4(jtag_check_value_mask_callback
, (jtag_callback_data_t
)in_fields
[i
].in_value
,
412 (jtag_callback_data_t
)in_fields
[i
].check_value
,
413 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
414 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
416 if (in_fields
[i
].allocated
)
418 free(in_fields
[i
].in_value
);
420 if (in_fields
[i
].modified
)
422 in_fields
[i
].in_value
= NULL
;
427 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
431 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
434 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
439 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
445 retval
= interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
446 jtag_set_error(retval
);
449 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
455 retval
= interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
456 jtag_set_error(retval
);
459 void jtag_add_dr_out(jtag_tap_t
* tap
,
460 int num_fields
, const int* num_bits
, const uint32_t* value
,
461 tap_state_t end_state
)
463 assert(end_state
!= TAP_INVALID
);
465 cmd_queue_cur_state
= end_state
;
467 interface_jtag_add_dr_out(tap
,
468 num_fields
, num_bits
, value
,
472 void jtag_add_tlr(void)
474 jtag_prelude(TAP_RESET
);
475 jtag_set_error(interface_jtag_add_tlr());
476 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
479 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
481 tap_state_t cur_state
= cmd_queue_cur_state
;
483 /* the last state has to be a stable state */
484 if (!tap_is_state_stable(path
[num_states
- 1]))
486 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
487 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
491 for (int i
= 0; i
< num_states
; i
++)
493 if (path
[i
] == TAP_RESET
)
495 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
496 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
500 if (tap_state_transition(cur_state
, true) != path
[i
]
501 && tap_state_transition(cur_state
, false) != path
[i
])
503 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
504 tap_state_name(cur_state
), tap_state_name(path
[i
]));
505 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
513 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
514 cmd_queue_cur_state
= path
[num_states
- 1];
517 int jtag_add_statemove(tap_state_t goal_state
)
519 tap_state_t cur_state
= cmd_queue_cur_state
;
521 LOG_DEBUG("cur_state=%s goal_state=%s",
522 tap_state_name(cur_state
),
523 tap_state_name(goal_state
));
526 if (goal_state
== cur_state
)
527 ; /* nothing to do */
528 else if (goal_state
== TAP_RESET
)
532 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
))
534 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
535 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
536 tap_state_t moves
[8];
537 assert(tms_count
< DIM(moves
));
539 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1)
541 bool bit
= tms_bits
& 1;
543 cur_state
= tap_state_transition(cur_state
, bit
);
544 moves
[i
] = cur_state
;
547 jtag_add_pathmove(tms_count
, moves
);
549 else if (tap_state_transition(cur_state
, true) == goal_state
550 || tap_state_transition(cur_state
, false) == goal_state
)
552 jtag_add_pathmove(1, &goal_state
);
561 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
564 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
568 void jtag_add_clocks(int num_cycles
)
570 if (!tap_is_state_stable(cmd_queue_cur_state
))
572 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
573 tap_state_name(cmd_queue_cur_state
));
574 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
581 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
585 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
587 int trst_with_tlr
= 0;
591 /* Without SRST, we must use target-specific JTAG operations
592 * on each target; callers should not be requesting SRST when
593 * that signal doesn't exist.
595 * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
596 * can kick in even if the JTAG adapter can't drive TRST.
599 if (!(jtag_reset_config
& RESET_HAS_SRST
)) {
600 LOG_ERROR("BUG: can't assert SRST");
601 jtag_set_error(ERROR_FAIL
);
604 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) != 0
605 && !req_tlr_or_trst
) {
606 LOG_ERROR("BUG: can't assert only SRST");
607 jtag_set_error(ERROR_FAIL
);
613 /* JTAG reset (entry to TAP_RESET state) can always be achieved
614 * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
615 * state first. TRST accelerates it, and bypasses those states.
617 * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
618 * can kick in even if the JTAG adapter can't drive SRST.
620 if (req_tlr_or_trst
) {
621 if (!(jtag_reset_config
& RESET_HAS_TRST
))
623 else if ((jtag_reset_config
& RESET_TRST_PULLS_SRST
) != 0
630 /* Maybe change TRST and/or SRST signal state */
631 if (jtag_srst
!= new_srst
|| jtag_trst
!= new_trst
) {
634 retval
= interface_jtag_add_reset(new_trst
, new_srst
);
635 if (retval
!= ERROR_OK
)
636 jtag_set_error(retval
);
638 retval
= jtag_execute_queue();
640 if (retval
!= ERROR_OK
) {
641 LOG_ERROR("TRST/SRST error %d", retval
);
646 /* SRST resets everything hooked up to that signal */
647 if (jtag_srst
!= new_srst
) {
648 jtag_srst
= new_srst
;
650 LOG_DEBUG("SRST line asserted");
652 LOG_DEBUG("SRST line released");
653 if (jtag_nsrst_delay
)
654 jtag_add_sleep(jtag_nsrst_delay
* 1000);
658 /* Maybe enter the JTAG TAP_RESET state ...
659 * - using only TMS, TCK, and the JTAG state machine
660 * - or else more directly, using TRST
662 * TAP_RESET should be invisible to non-debug parts of the system.
665 LOG_DEBUG("JTAG reset with TLR instead of TRST");
666 jtag_set_end_state(TAP_RESET
);
669 } else if (jtag_trst
!= new_trst
) {
670 jtag_trst
= new_trst
;
672 /* we just asserted nTRST, so we're now in TAP_RESET;
673 * inform possible listeners about this
675 * REVISIT asserting TRST is less significant than
676 * being in TAP_RESET ... both entries (TRST, TLR)
677 * should trigger a callback.
679 LOG_DEBUG("TRST line asserted");
680 tap_set_state(TAP_RESET
);
681 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
683 LOG_DEBUG("TRST line released");
684 if (jtag_ntrst_delay
)
685 jtag_add_sleep(jtag_ntrst_delay
* 1000);
690 tap_state_t
jtag_set_end_state(tap_state_t state
)
692 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
694 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
697 if (state
!= TAP_INVALID
)
698 cmd_queue_end_state
= state
;
699 return cmd_queue_end_state
;
702 tap_state_t
jtag_get_end_state(void)
704 return cmd_queue_end_state
;
707 void jtag_add_sleep(uint32_t us
)
709 /// @todo Here, keep_alive() appears to be a layering violation!!!
711 jtag_set_error(interface_jtag_add_sleep(us
));
714 int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
, uint8_t *in_check_mask
, int num_bits
)
716 int retval
= ERROR_OK
;
718 int compare_failed
= 0;
721 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
723 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
725 if (compare_failed
) {
726 /* An error handler could have caught the failing check
727 * only report a problem when there wasn't a handler, or if the handler
728 * acknowledged the error
731 LOG_WARNING("TAP %s:",
732 jtag_tap_name(field->tap));
736 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
737 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
741 char *in_check_mask_char
;
742 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
743 LOG_WARNING("value captured during scan didn't pass the requested check:");
744 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
745 captured_char
, in_check_value_char
, in_check_mask_char
);
746 free(in_check_mask_char
);
750 LOG_WARNING("value captured during scan didn't pass the requested check: captured: 0x%s check_value: 0x%s", captured_char
, in_check_value_char
);
754 free(in_check_value_char
);
756 retval
= ERROR_JTAG_QUEUE_FAILED
;
763 void jtag_check_value_mask(scan_field_t
*field
, uint8_t *value
, uint8_t *mask
)
765 assert(field
->in_value
!= NULL
);
769 /* no checking to do */
773 jtag_execute_queue_noclear();
775 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
776 jtag_set_error(retval
);
781 int default_interface_jtag_execute_queue(void)
785 LOG_ERROR("No JTAG interface configured yet. "
786 "Issue 'init' command in startup scripts "
787 "before communicating with targets.");
791 return jtag
->execute_queue();
794 void jtag_execute_queue_noclear(void)
796 jtag_flush_queue_count
++;
797 jtag_set_error(interface_jtag_execute_queue());
800 int jtag_get_flush_queue_count(void)
802 return jtag_flush_queue_count
;
805 int jtag_execute_queue(void)
807 jtag_execute_queue_noclear();
808 return jtag_error_clear();
811 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
813 jtag_tap_t
*tap
= priv
;
817 if (event
== JTAG_TRST_ASSERTED
)
819 tap
->enabled
= !tap
->disabled_after_reset
;
821 /* current instruction is either BYPASS or IDCODE */
822 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
829 void jtag_sleep(uint32_t us
)
831 alive_sleep(us
/1000);
834 /// maximum number of JTAG devices expected in the chain
835 #define JTAG_MAX_CHAIN_SIZE 20
837 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
838 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
839 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
841 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
843 scan_field_t field
= {
845 .num_bits
= num_idcode
* 32,
846 .out_value
= idcode_buffer
,
847 .in_value
= idcode_buffer
,
850 // initialize to the end of chain ID value
851 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
852 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
854 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
855 return jtag_execute_queue();
858 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
860 uint8_t zero_check
= 0x0;
861 uint8_t one_check
= 0xff;
863 for (unsigned i
= 0; i
< count
* 4; i
++)
865 zero_check
|= idcodes
[i
];
866 one_check
&= idcodes
[i
];
869 /* if there wasn't a single non-zero bit or if all bits were one,
870 * the scan is not valid */
871 if (zero_check
== 0x00 || one_check
== 0xff)
873 LOG_ERROR("JTAG communication failure: check connection, "
874 "JTAG interface, target power etc.");
880 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
881 const char *name
, uint32_t idcode
)
883 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
884 "JTAG tap: %s %16.16s: 0x%08x "
885 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
887 (unsigned int)idcode
,
888 (unsigned int)EXTRACT_MFG(idcode
),
889 (unsigned int)EXTRACT_PART(idcode
),
890 (unsigned int)EXTRACT_VER(idcode
));
893 static bool jtag_idcode_is_final(uint32_t idcode
)
895 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
899 * This helper checks that remaining bits in the examined chain data are
900 * all as expected, but a single JTAG device requires only 64 bits to be
901 * read back correctly. This can help identify and diagnose problems
902 * with the JTAG chain earlier, gives more helpful/explicit error messages.
904 static void jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
906 bool triggered
= false;
907 for (; count
< max
- 31; count
+= 32)
909 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
910 // do not trigger the warning if the data looks good
911 if (!triggered
&& jtag_idcode_is_final(idcode
))
913 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
914 count
, (unsigned int)idcode
);
919 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
921 if (0 == tap
->expected_ids_cnt
)
923 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
925 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
926 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
931 /* Loop over the expected identification codes and test for a match */
933 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
935 if (tap
->idcode
== tap
->expected_ids
[ii
])
939 /* If none of the expected ids matched, log an error */
940 if (ii
!= tap
->expected_ids_cnt
)
942 LOG_DEBUG("JTAG Tap/device matched");
945 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
946 tap
->dotted_name
, tap
->idcode
);
947 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
950 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
951 ii
+ 1, tap
->expected_ids_cnt
);
952 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
953 tap
->dotted_name
, tap
->expected_ids
[ii
]);
958 /* Try to examine chain layout according to IEEE 1149.1 §12
960 int jtag_examine_chain(void)
962 uint8_t idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
963 unsigned device_count
= 0;
965 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
967 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
968 return ERROR_JTAG_INIT_FAILED
;
970 /* point at the 1st tap */
971 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
974 LOG_ERROR("JTAG: No taps enabled?");
975 return ERROR_JTAG_INIT_FAILED
;
978 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
980 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
981 tap
->hasidcode
= true;
982 if ((idcode
& 1) == 0)
984 /* LSB must not be 0, this indicates a device in bypass */
985 LOG_WARNING("Tap/Device does not have IDCODE");
987 tap
->hasidcode
= false;
994 * End of chain (invalid manufacturer ID) some devices, such
995 * as AVR will output all 1's instead of TDI input value at
998 if (jtag_idcode_is_final(idcode
))
1000 jtag_examine_chain_end(idcode_buffer
,
1001 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1005 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1006 tap
? tap
->dotted_name
: "(not-named)",
1015 tap
->idcode
= idcode
;
1017 // ensure the TAP ID does matches what was expected
1018 if (!jtag_examine_chain_match_tap(tap
))
1019 return ERROR_JTAG_INIT_FAILED
;
1021 tap
= jtag_tap_next_enabled(tap
);
1024 /* see if number of discovered devices matches configuration */
1025 if (device_count
!= jtag_tap_count_enabled())
1027 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1028 "does not match (enabled) configuration (%i), total taps: %d",
1029 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1030 LOG_ERROR("check the config file and ensure proper JTAG communication"
1031 " (connections, speed, ...)");
1032 return ERROR_JTAG_INIT_FAILED
;
1038 int jtag_validate_chain(void)
1041 int total_ir_length
= 0;
1042 uint8_t *ir_test
= NULL
;
1047 total_ir_length
= 0;
1049 tap
= jtag_tap_next_enabled(tap
);
1053 total_ir_length
+= tap
->ir_length
;
1056 total_ir_length
+= 2;
1057 ir_test
= malloc(CEIL(total_ir_length
, 8));
1058 buf_set_ones(ir_test
, total_ir_length
);
1061 field
.num_bits
= total_ir_length
;
1062 field
.out_value
= ir_test
;
1063 field
.in_value
= ir_test
;
1066 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1068 retval
= jtag_execute_queue();
1069 if (retval
!= ERROR_OK
)
1076 tap
= jtag_tap_next_enabled(tap
);
1081 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1082 /* Only fail this check if we have IDCODE for this device */
1083 if ((val
!= 0x1)&&(tap
->hasidcode
))
1085 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1086 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
);
1089 return ERROR_JTAG_INIT_FAILED
;
1091 chain_pos
+= tap
->ir_length
;
1094 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1097 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1098 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
);
1101 return ERROR_JTAG_INIT_FAILED
;
1110 void jtag_tap_init(jtag_tap_t
*tap
)
1112 assert(0 != tap
->ir_length
);
1114 tap
->expected
= malloc(tap
->ir_length
);
1115 tap
->expected_mask
= malloc(tap
->ir_length
);
1116 tap
->cur_instr
= malloc(tap
->ir_length
);
1118 /// @todo cope sanely with ir_length bigger than 32 bits
1119 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1120 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1121 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1123 // place TAP in bypass mode
1125 // register the reset callback for the TAP
1126 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1128 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1129 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1130 tap
->abs_chain_position
, tap
->ir_length
,
1131 (unsigned int)(tap
->ir_capture_value
), (unsigned int)(tap
->ir_capture_mask
));
1135 void jtag_tap_free(jtag_tap_t
*tap
)
1137 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1139 /// @todo is anything missing? no memory leaks please
1140 free((void *)tap
->expected_ids
);
1141 free((void *)tap
->chip
);
1142 free((void *)tap
->tapname
);
1143 free((void *)tap
->dotted_name
);
1147 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1152 if (!jtag_interface
)
1154 /* nothing was previously specified by "interface" command */
1155 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1156 return ERROR_JTAG_INVALID_INTERFACE
;
1159 jtag
= jtag_interface
;
1160 if (jtag_interface
->init() != ERROR_OK
)
1163 return ERROR_JTAG_INIT_FAILED
;
1166 int requested_khz
= jtag_get_speed_khz();
1167 int actual_khz
= requested_khz
;
1168 int retval
= jtag_get_speed_readable(&actual_khz
);
1169 if (ERROR_OK
!= retval
)
1170 LOG_INFO("interface specific clock speed value %d", jtag_get_speed());
1171 else if (actual_khz
)
1173 if ((CLOCK_MODE_RCLK
== clock_mode
)
1174 || ((CLOCK_MODE_KHZ
== clock_mode
) && !requested_khz
))
1176 LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1180 LOG_INFO("clock speed %d kHz", actual_khz
);
1183 LOG_INFO("RCLK (adaptive clock speed)");
1188 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1193 LOG_DEBUG("Init JTAG chain");
1195 tap
= jtag_tap_next_enabled(NULL
);
1197 LOG_ERROR("There are no enabled taps?");
1198 return ERROR_JTAG_INIT_FAILED
;
1202 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1205 /* examine chain first, as this could discover the real chain layout */
1206 if (jtag_examine_chain() != ERROR_OK
)
1208 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1211 if (jtag_validate_chain() != ERROR_OK
)
1213 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1219 int jtag_interface_quit(void)
1221 if (!jtag
|| !jtag
->quit
)
1224 // close the JTAG interface
1225 int result
= jtag
->quit();
1226 if (ERROR_OK
!= result
)
1227 LOG_ERROR("failed: %d", result
);
1233 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1237 if ((retval
= jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1240 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / TLR");
1242 /* Reset can happen after a power cycle.
1244 * Ideally we would only assert TRST or run TLR before the target reset.
1246 * However w/srst_pulls_trst, trst is asserted together with the target
1247 * reset whether we want it or not.
1249 * NB! Some targets have JTAG circuitry disabled until a
1250 * trst & srst has been asserted.
1252 * NB! here we assume nsrst/ntrst delay are sufficient!
1254 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1257 jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1258 if (jtag_reset_config
& RESET_HAS_SRST
)
1260 jtag_add_reset(1, 1);
1261 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1262 jtag_add_reset(0, 1);
1264 jtag_add_reset(0, 0);
1265 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1268 /* Check that we can communication on the JTAG chain + eventually we want to
1269 * be able to perform enumeration only after OpenOCD has started
1270 * telnet and GDB server
1272 * That would allow users to more easily perform any magic they need to before
1275 return jtag_init_inner(cmd_ctx
);
1278 int jtag_init(struct command_context_s
*cmd_ctx
)
1281 if ((retval
= jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1283 if (jtag_init_inner(cmd_ctx
) == ERROR_OK
)
1287 return jtag_init_reset(cmd_ctx
);
1290 unsigned jtag_get_speed_khz(void)
1295 static int jtag_khz_to_speed(unsigned khz
, int* speed
)
1297 LOG_DEBUG("convert khz to interface specific speed value");
1301 LOG_DEBUG("have interface set up");
1303 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1304 if (ERROR_OK
!= retval
)
1308 *speed
= speed_div1
;
1313 static int jtag_rclk_to_speed(unsigned fallback_speed_khz
, int* speed
)
1315 int retval
= jtag_khz_to_speed(0, speed
);
1316 if ((ERROR_OK
!= retval
) && fallback_speed_khz
)
1318 LOG_DEBUG("trying fallback speed...");
1319 retval
= jtag_khz_to_speed(fallback_speed_khz
, speed
);
1324 static int jtag_set_speed(int speed
)
1327 /* this command can be called during CONFIG,
1328 * in which case jtag isn't initialized */
1329 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1332 int jtag_config_speed(int speed
)
1334 LOG_DEBUG("handle jtag speed");
1335 clock_mode
= CLOCK_MODE_SPEED
;
1336 return jtag_set_speed(speed
);
1339 int jtag_config_khz(unsigned khz
)
1341 LOG_DEBUG("handle jtag khz");
1342 clock_mode
= CLOCK_MODE_KHZ
;
1344 int retval
= jtag_khz_to_speed(khz
, &speed
);
1345 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1348 int jtag_config_rclk(unsigned fallback_speed_khz
)
1350 LOG_DEBUG("handle jtag rclk");
1351 clock_mode
= CLOCK_MODE_RCLK
;
1352 rclk_fallback_speed_khz
= fallback_speed_khz
;
1354 int retval
= jtag_rclk_to_speed(fallback_speed_khz
, &speed
);
1355 return (ERROR_OK
!= retval
) ? retval
: jtag_set_speed(speed
);
1358 int jtag_get_speed(void)
1363 case CLOCK_MODE_SPEED
:
1366 case CLOCK_MODE_KHZ
:
1367 jtag_khz_to_speed(jtag_get_speed_khz(), &speed
);
1369 case CLOCK_MODE_RCLK
:
1370 jtag_rclk_to_speed(rclk_fallback_speed_khz
, &speed
);
1373 LOG_ERROR("BUG: unknown jtag clock mode");
1380 int jtag_get_speed_readable(int *khz
)
1382 return jtag
? jtag
->speed_div(jtag_get_speed(), khz
) : ERROR_OK
;
1385 void jtag_set_verify(bool enable
)
1387 jtag_verify
= enable
;
1390 bool jtag_will_verify()
1395 void jtag_set_verify_capture_ir(bool enable
)
1397 jtag_verify_capture_ir
= enable
;
1400 bool jtag_will_verify_capture_ir()
1402 return jtag_verify_capture_ir
;
1405 int jtag_power_dropout(int *dropout
)
1407 return jtag
->power_dropout(dropout
);
1410 int jtag_srst_asserted(int *srst_asserted
)
1412 return jtag
->srst_asserted(srst_asserted
);
1415 enum reset_types
jtag_get_reset_config(void)
1417 return jtag_reset_config
;
1419 void jtag_set_reset_config(enum reset_types type
)
1421 jtag_reset_config
= type
;
1424 int jtag_get_trst(void)
1428 int jtag_get_srst(void)
1433 void jtag_set_nsrst_delay(unsigned delay
)
1435 jtag_nsrst_delay
= delay
;
1437 unsigned jtag_get_nsrst_delay(void)
1439 return jtag_nsrst_delay
;
1441 void jtag_set_ntrst_delay(unsigned delay
)
1443 jtag_ntrst_delay
= delay
;
1445 unsigned jtag_get_ntrst_delay(void)
1447 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)