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 (RESET or TRST)",
64 [JTAG_TAP_EVENT_ENABLE
] = "TAP enabled",
65 [JTAG_TAP_EVENT_DISABLE
] = "TAP disabled",
68 static int jtag_trst
= 0;
69 static int jtag_srst
= 0;
72 * List all TAPs that have been created.
74 static jtag_tap_t
*__jtag_all_taps
= NULL
;
76 * The number of TAPs in the __jtag_all_taps list, used to track the
77 * assigned chain position to new TAPs
79 static unsigned jtag_num_taps
= 0;
81 static enum reset_types jtag_reset_config
= RESET_NONE
;
82 static tap_state_t cmd_queue_end_state
= TAP_RESET
;
83 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
85 static bool jtag_verify_capture_ir
= true;
86 static int jtag_verify
= 1;
88 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
89 static int jtag_nsrst_delay
= 0; /* default to no nSRST delay */
90 static int jtag_ntrst_delay
= 0; /* default to no nTRST delay */
92 typedef struct jtag_event_callback_s
94 jtag_event_handler_t callback
;
96 struct jtag_event_callback_s
* next
;
97 } jtag_event_callback_t
;
99 /* callbacks to inform high-level handlers about JTAG state changes */
100 static jtag_event_callback_t
*jtag_event_callbacks
;
103 static int speed_khz
= 0;
104 /* flag if the kHz speed was defined */
105 static bool hasKHz
= false;
106 static int jtag_speed
= 0;
108 static struct jtag_interface_s
*jtag
= NULL
;
111 jtag_interface_t
*jtag_interface
= NULL
;
113 void jtag_set_error(int error
)
115 if ((error
== ERROR_OK
) || (jtag_error
!= ERROR_OK
))
119 int jtag_get_error(void)
123 int jtag_error_clear(void)
125 int temp
= jtag_error
;
126 jtag_error
= ERROR_OK
;
131 jtag_tap_t
*jtag_all_taps(void)
133 return __jtag_all_taps
;
136 unsigned jtag_tap_count(void)
138 return jtag_num_taps
;
141 unsigned jtag_tap_count_enabled(void)
143 jtag_tap_t
*t
= jtag_all_taps();
154 /// Append a new TAP to the chain of all taps.
155 void jtag_tap_add(struct jtag_tap_s
*t
)
157 t
->abs_chain_position
= jtag_num_taps
++;
159 jtag_tap_t
**tap
= &__jtag_all_taps
;
161 tap
= &(*tap
)->next_tap
;
165 /* returns a pointer to the n-th device in the scan chain */
166 static inline jtag_tap_t
*jtag_tap_by_position(unsigned n
)
168 jtag_tap_t
*t
= jtag_all_taps();
176 jtag_tap_t
*jtag_tap_by_string(const char *s
)
178 /* try by name first */
179 jtag_tap_t
*t
= jtag_all_taps();
183 if (0 == strcmp(t
->dotted_name
, s
))
188 /* no tap found by name, so try to parse the name as a number */
190 if (parse_uint(s
, &n
) != ERROR_OK
)
193 /* FIXME remove this numeric fallback code late June 2010, along
194 * with all info in the User's Guide that TAPs have numeric IDs.
195 * Also update "scan_chain" output to not display the numbers.
197 t
= jtag_tap_by_position(n
);
199 LOG_WARNING("Specify TAP '%s' by name, not number %u",
205 jtag_tap_t
*jtag_tap_by_jim_obj(Jim_Interp
*interp
, Jim_Obj
*o
)
207 const char *cp
= Jim_GetString(o
, NULL
);
208 jtag_tap_t
*t
= cp
? jtag_tap_by_string(cp
) : NULL
;
212 Jim_SetResult_sprintf(interp
, "Tap '%s' could not be found", cp
);
216 jtag_tap_t
* jtag_tap_next_enabled(jtag_tap_t
* p
)
218 p
= p
? p
->next_tap
: jtag_all_taps();
228 const char *jtag_tap_name(const jtag_tap_t
*tap
)
230 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
234 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
236 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
238 if (callback
== NULL
)
240 return ERROR_INVALID_ARGUMENTS
;
245 while ((*callbacks_p
)->next
)
246 callbacks_p
= &((*callbacks_p
)->next
);
247 callbacks_p
= &((*callbacks_p
)->next
);
250 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
251 (*callbacks_p
)->callback
= callback
;
252 (*callbacks_p
)->priv
= priv
;
253 (*callbacks_p
)->next
= NULL
;
258 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
260 jtag_event_callback_t
**callbacks_p
;
261 jtag_event_callback_t
**next
;
263 if (callback
== NULL
)
265 return ERROR_INVALID_ARGUMENTS
;
268 for (callbacks_p
= &jtag_event_callbacks
;
269 *callbacks_p
!= NULL
;
272 next
= &((*callbacks_p
)->next
);
274 if ((*callbacks_p
)->priv
!= priv
)
277 if ((*callbacks_p
)->callback
== callback
)
280 *callbacks_p
= *next
;
287 int jtag_call_event_callbacks(enum jtag_event event
)
289 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
291 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
295 jtag_event_callback_t
*next
;
297 /* callback may remove itself */
298 next
= callback
->next
;
299 callback
->callback(event
, callback
->priv
);
306 static void jtag_checks(void)
308 assert(jtag_trst
== 0);
311 static void jtag_prelude(tap_state_t state
)
315 assert(state
!= TAP_INVALID
);
317 cmd_queue_cur_state
= state
;
320 void jtag_alloc_in_value32(scan_field_t
*field
)
322 interface_jtag_alloc_in_value32(field
);
325 void jtag_add_ir_scan_noverify(int in_count
, const scan_field_t
*in_fields
,
330 int retval
= interface_jtag_add_ir_scan(in_count
, in_fields
, state
);
331 jtag_set_error(retval
);
335 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
337 if (jtag_verify
&& jtag_verify_capture_ir
)
339 /* 8 x 32 bit id's is enough for all invocations */
341 for (int j
= 0; j
< in_num_fields
; j
++)
343 /* if we are to run a verification of the ir scan, we need to get the input back.
344 * We may have to allocate space if the caller didn't ask for the input back.
346 in_fields
[j
].check_value
= in_fields
[j
].tap
->expected
;
347 in_fields
[j
].check_mask
= in_fields
[j
].tap
->expected_mask
;
349 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
352 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
356 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
,
361 int retval
= interface_jtag_add_plain_ir_scan(
362 in_num_fields
, in_fields
, state
);
363 jtag_set_error(retval
);
366 void jtag_add_callback(jtag_callback1_t f
, jtag_callback_data_t data0
)
368 interface_jtag_add_callback(f
, data0
);
371 void jtag_add_callback4(jtag_callback_t f
, jtag_callback_data_t data0
,
372 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
373 jtag_callback_data_t data3
)
375 interface_jtag_add_callback4(f
, data0
, data1
, data2
, data3
);
378 int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
, uint8_t *in_check_mask
, int num_bits
);
380 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
)
382 return jtag_check_value_inner((uint8_t *)data0
, (uint8_t *)data1
, (uint8_t *)data2
, (int)data3
);
385 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
386 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
388 for (int i
= 0; i
< in_num_fields
; i
++)
390 struct scan_field_s
*field
= &in_fields
[i
];
391 field
->allocated
= 0;
393 if (field
->check_value
|| field
->in_value
)
395 interface_jtag_add_scan_check_alloc(field
);
399 jtag_add_scan(in_num_fields
, in_fields
, state
);
401 for (int i
= 0; i
< in_num_fields
; i
++)
403 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
405 /* this is synchronous for a minidriver */
406 jtag_add_callback4(jtag_check_value_mask_callback
, (jtag_callback_data_t
)in_fields
[i
].in_value
,
407 (jtag_callback_data_t
)in_fields
[i
].check_value
,
408 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
409 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
411 if (in_fields
[i
].allocated
)
413 free(in_fields
[i
].in_value
);
415 if (in_fields
[i
].modified
)
417 in_fields
[i
].in_value
= NULL
;
422 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
426 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
429 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
434 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
440 retval
= interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
441 jtag_set_error(retval
);
444 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
450 retval
= interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
451 jtag_set_error(retval
);
454 void jtag_add_dr_out(jtag_tap_t
* tap
,
455 int num_fields
, const int* num_bits
, const uint32_t* value
,
456 tap_state_t end_state
)
458 assert(end_state
!= TAP_INVALID
);
460 cmd_queue_cur_state
= end_state
;
462 interface_jtag_add_dr_out(tap
,
463 num_fields
, num_bits
, value
,
467 void jtag_add_tlr(void)
469 jtag_prelude(TAP_RESET
);
470 jtag_set_error(interface_jtag_add_tlr());
471 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
474 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
476 tap_state_t cur_state
= cmd_queue_cur_state
;
478 /* the last state has to be a stable state */
479 if (!tap_is_state_stable(path
[num_states
- 1]))
481 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
482 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
486 for (int i
= 0; i
< num_states
; i
++)
488 if (path
[i
] == TAP_RESET
)
490 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
491 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
495 if (tap_state_transition(cur_state
, true) != path
[i
]
496 && tap_state_transition(cur_state
, false) != path
[i
])
498 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
499 tap_state_name(cur_state
), tap_state_name(path
[i
]));
500 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
508 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
509 cmd_queue_cur_state
= path
[num_states
- 1];
512 int jtag_add_statemove(tap_state_t goal_state
)
514 tap_state_t cur_state
= cmd_queue_cur_state
;
516 LOG_DEBUG("cur_state=%s goal_state=%s",
517 tap_state_name(cur_state
),
518 tap_state_name(goal_state
));
521 if (goal_state
== cur_state
)
522 ; /* nothing to do */
523 else if (goal_state
== TAP_RESET
)
527 else if (tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
))
529 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
530 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
531 tap_state_t moves
[8];
532 assert(tms_count
< DIM(moves
));
534 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1)
536 bool bit
= tms_bits
& 1;
538 cur_state
= tap_state_transition(cur_state
, bit
);
539 moves
[i
] = cur_state
;
542 jtag_add_pathmove(tms_count
, moves
);
544 else if (tap_state_transition(cur_state
, true) == goal_state
545 || tap_state_transition(cur_state
, false) == goal_state
)
547 jtag_add_pathmove(1, &goal_state
);
556 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
559 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
563 void jtag_add_clocks(int num_cycles
)
565 if (!tap_is_state_stable(cmd_queue_cur_state
))
567 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
568 tap_state_name(cmd_queue_cur_state
));
569 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
576 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
580 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
582 int trst_with_tlr
= 0;
584 /* FIX!!! there are *many* different cases here. A better
585 * approach is needed for legal combinations of transitions...
587 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
588 (jtag_reset_config
& RESET_HAS_TRST
)&&
589 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0))
591 if (((req_tlr_or_trst
&&!jtag_trst
)||
592 (!req_tlr_or_trst
&& jtag_trst
))&&
593 ((req_srst
&&!jtag_srst
)||
594 (!req_srst
&& jtag_srst
)))
596 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
597 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
601 /* Make sure that jtag_reset_config allows the requested reset */
602 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
603 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
605 LOG_ERROR("BUG: requested reset would assert trst");
606 jtag_set_error(ERROR_FAIL
);
610 /* if TRST pulls SRST, we reset with TAP T-L-R */
611 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
616 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
618 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
619 jtag_set_error(ERROR_FAIL
);
625 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
637 jtag_srst
= req_srst
;
639 int retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
640 if (retval
!= ERROR_OK
)
642 jtag_set_error(retval
);
645 jtag_execute_queue();
649 LOG_DEBUG("SRST line asserted");
653 LOG_DEBUG("SRST line released");
654 if (jtag_nsrst_delay
)
655 jtag_add_sleep(jtag_nsrst_delay
* 1000);
660 LOG_DEBUG("JTAG reset with RESET instead of TRST");
661 jtag_set_end_state(TAP_RESET
);
668 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
669 * and inform possible listeners about this
671 LOG_DEBUG("TRST line asserted");
672 tap_set_state(TAP_RESET
);
673 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
677 if (jtag_ntrst_delay
)
678 jtag_add_sleep(jtag_ntrst_delay
* 1000);
682 tap_state_t
jtag_set_end_state(tap_state_t state
)
684 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
686 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
689 if (state
!= TAP_INVALID
)
690 cmd_queue_end_state
= state
;
691 return cmd_queue_end_state
;
694 tap_state_t
jtag_get_end_state(void)
696 return cmd_queue_end_state
;
699 void jtag_add_sleep(uint32_t us
)
701 /// @todo Here, keep_alive() appears to be a layering violation!!!
703 jtag_set_error(interface_jtag_add_sleep(us
));
706 int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
, uint8_t *in_check_mask
, int num_bits
)
708 int retval
= ERROR_OK
;
710 int compare_failed
= 0;
713 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
715 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
717 if (compare_failed
) {
718 /* An error handler could have caught the failing check
719 * only report a problem when there wasn't a handler, or if the handler
720 * acknowledged the error
723 LOG_WARNING("TAP %s:",
724 jtag_tap_name(field->tap));
728 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
729 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
733 char *in_check_mask_char
;
734 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
735 LOG_WARNING("value captured during scan didn't pass the requested check:");
736 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
737 captured_char
, in_check_value_char
, in_check_mask_char
);
738 free(in_check_mask_char
);
742 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
);
746 free(in_check_value_char
);
748 retval
= ERROR_JTAG_QUEUE_FAILED
;
755 void jtag_check_value_mask(scan_field_t
*field
, uint8_t *value
, uint8_t *mask
)
757 assert(field
->in_value
!= NULL
);
761 /* no checking to do */
765 jtag_execute_queue_noclear();
767 int retval
= jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
768 jtag_set_error(retval
);
773 int default_interface_jtag_execute_queue(void)
777 LOG_ERROR("No JTAG interface configured yet. "
778 "Issue 'init' command in startup scripts "
779 "before communicating with targets.");
783 return jtag
->execute_queue();
786 void jtag_execute_queue_noclear(void)
788 jtag_flush_queue_count
++;
789 jtag_set_error(interface_jtag_execute_queue());
792 int jtag_get_flush_queue_count(void)
794 return jtag_flush_queue_count
;
797 int jtag_execute_queue(void)
799 jtag_execute_queue_noclear();
800 return jtag_error_clear();
803 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
805 jtag_tap_t
*tap
= priv
;
809 if (event
== JTAG_TRST_ASSERTED
)
811 tap
->enabled
= !tap
->disabled_after_reset
;
813 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
820 void jtag_sleep(uint32_t us
)
822 alive_sleep(us
/1000);
825 /// maximum number of JTAG devices expected in the chain
826 #define JTAG_MAX_CHAIN_SIZE 20
828 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
829 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
830 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
832 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
834 scan_field_t field
= {
836 .num_bits
= num_idcode
* 32,
837 .out_value
= idcode_buffer
,
838 .in_value
= idcode_buffer
,
841 // initialize to the end of chain ID value
842 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
843 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
845 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
846 return jtag_execute_queue();
849 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
851 uint8_t zero_check
= 0x0;
852 uint8_t one_check
= 0xff;
854 for (unsigned i
= 0; i
< count
* 4; i
++)
856 zero_check
|= idcodes
[i
];
857 one_check
&= idcodes
[i
];
860 /* if there wasn't a single non-zero bit or if all bits were one,
861 * the scan is not valid */
862 if (zero_check
== 0x00 || one_check
== 0xff)
864 LOG_ERROR("JTAG communication failure: check connection, "
865 "JTAG interface, target power etc.");
871 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
872 const char *name
, uint32_t idcode
)
874 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
875 "JTAG tap: %s %16.16s: 0x%08x "
876 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
878 (unsigned int)idcode
,
879 (unsigned int)EXTRACT_MFG(idcode
),
880 (unsigned int)EXTRACT_PART(idcode
),
881 (unsigned int)EXTRACT_VER(idcode
));
884 static bool jtag_idcode_is_final(uint32_t idcode
)
886 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
890 * This helper checks that remaining bits in the examined chain data are
891 * all as expected, but a single JTAG device requires only 64 bits to be
892 * read back correctly. This can help identify and diagnose problems
893 * with the JTAG chain earlier, gives more helpful/explicit error messages.
895 static void jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
897 bool triggered
= false;
898 for (; count
< max
- 31; count
+= 32)
900 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
901 // do not trigger the warning if the data looks good
902 if (!triggered
&& jtag_idcode_is_final(idcode
))
904 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
905 count
, (unsigned int)idcode
);
910 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
912 if (0 == tap
->expected_ids_cnt
)
914 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
916 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
917 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
922 /* Loop over the expected identification codes and test for a match */
924 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
926 if (tap
->idcode
== tap
->expected_ids
[ii
])
930 /* If none of the expected ids matched, log an error */
931 if (ii
!= tap
->expected_ids_cnt
)
933 LOG_INFO("JTAG Tap/device matched");
936 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
937 tap
->dotted_name
, tap
->idcode
);
938 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
941 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
942 ii
+ 1, tap
->expected_ids_cnt
);
943 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
944 tap
->dotted_name
, tap
->expected_ids
[ii
]);
949 /* Try to examine chain layout according to IEEE 1149.1 §12
951 int jtag_examine_chain(void)
953 uint8_t idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
954 unsigned device_count
= 0;
956 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
958 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
959 return ERROR_JTAG_INIT_FAILED
;
961 /* point at the 1st tap */
962 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
965 LOG_ERROR("JTAG: No taps enabled?");
966 return ERROR_JTAG_INIT_FAILED
;
969 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
971 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
972 if ((idcode
& 1) == 0)
974 /* LSB must not be 0, this indicates a device in bypass */
975 LOG_WARNING("Tap/Device does not have IDCODE");
983 * End of chain (invalid manufacturer ID) some devices, such
984 * as AVR will output all 1's instead of TDI input value at
987 if (jtag_idcode_is_final(idcode
))
989 jtag_examine_chain_end(idcode_buffer
,
990 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
994 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
995 tap
? tap
->dotted_name
: "(not-named)",
1004 tap
->idcode
= idcode
;
1006 // ensure the TAP ID does matches what was expected
1007 if (!jtag_examine_chain_match_tap(tap
))
1008 return ERROR_JTAG_INIT_FAILED
;
1010 tap
= jtag_tap_next_enabled(tap
);
1013 /* see if number of discovered devices matches configuration */
1014 if (device_count
!= jtag_tap_count_enabled())
1016 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1017 "does not match (enabled) configuration (%i), total taps: %d",
1018 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1019 LOG_ERROR("check the config file and ensure proper JTAG communication"
1020 " (connections, speed, ...)");
1021 return ERROR_JTAG_INIT_FAILED
;
1027 int jtag_validate_chain(void)
1030 int total_ir_length
= 0;
1031 uint8_t *ir_test
= NULL
;
1036 total_ir_length
= 0;
1038 tap
= jtag_tap_next_enabled(tap
);
1042 total_ir_length
+= tap
->ir_length
;
1045 total_ir_length
+= 2;
1046 ir_test
= malloc(CEIL(total_ir_length
, 8));
1047 buf_set_ones(ir_test
, total_ir_length
);
1050 field
.num_bits
= total_ir_length
;
1051 field
.out_value
= ir_test
;
1052 field
.in_value
= ir_test
;
1055 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1056 jtag_execute_queue();
1062 tap
= jtag_tap_next_enabled(tap
);
1067 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1070 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1071 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
);
1074 return ERROR_JTAG_INIT_FAILED
;
1076 chain_pos
+= tap
->ir_length
;
1079 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1082 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1083 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
);
1086 return ERROR_JTAG_INIT_FAILED
;
1095 void jtag_tap_init(jtag_tap_t
*tap
)
1097 assert(0 != tap
->ir_length
);
1099 tap
->expected
= malloc(tap
->ir_length
);
1100 tap
->expected_mask
= malloc(tap
->ir_length
);
1101 tap
->cur_instr
= malloc(tap
->ir_length
);
1103 /// @todo cope sanely with ir_length bigger than 32 bits
1104 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1105 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1106 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1108 // place TAP in bypass mode
1110 // register the reset callback for the TAP
1111 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1113 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1114 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1115 tap
->abs_chain_position
, tap
->ir_length
,
1116 (unsigned int)(tap
->ir_capture_value
), (unsigned int)(tap
->ir_capture_mask
));
1120 void jtag_tap_free(jtag_tap_t
*tap
)
1122 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1124 /// @todo is anything missing? no memory leaks please
1125 free((void *)tap
->expected_ids
);
1126 free((void *)tap
->chip
);
1127 free((void *)tap
->tapname
);
1128 free((void *)tap
->dotted_name
);
1132 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1137 if (!jtag_interface
)
1139 /* nothing was previously specified by "interface" command */
1140 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1141 return ERROR_JTAG_INVALID_INTERFACE
;
1145 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1149 if (jtag_interface
->init() != ERROR_OK
)
1150 return ERROR_JTAG_INIT_FAILED
;
1152 jtag
= jtag_interface
;
1156 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1161 LOG_DEBUG("Init JTAG chain");
1163 tap
= jtag_tap_next_enabled(NULL
);
1165 LOG_ERROR("There are no enabled taps?");
1166 return ERROR_JTAG_INIT_FAILED
;
1170 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1173 /* examine chain first, as this could discover the real chain layout */
1174 if (jtag_examine_chain() != ERROR_OK
)
1176 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1179 if (jtag_validate_chain() != ERROR_OK
)
1181 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1187 int jtag_interface_quit(void)
1189 if (!jtag
|| !jtag
->quit
)
1192 // close the JTAG interface
1193 int result
= jtag
->quit();
1194 if (ERROR_OK
!= result
)
1195 LOG_ERROR("failed: %d", result
);
1201 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1205 if ((retval
= jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1208 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1210 /* Reset can happen after a power cycle.
1212 * Ideally we would only assert TRST or run RESET before the target reset.
1214 * However w/srst_pulls_trst, trst is asserted together with the target
1215 * reset whether we want it or not.
1217 * NB! Some targets have JTAG circuitry disabled until a
1218 * trst & srst has been asserted.
1220 * NB! here we assume nsrst/ntrst delay are sufficient!
1222 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1225 jtag_add_reset(1, 0); /* RESET or TRST */
1226 if (jtag_reset_config
& RESET_HAS_SRST
)
1228 jtag_add_reset(1, 1);
1229 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
) == 0)
1230 jtag_add_reset(0, 1);
1232 jtag_add_reset(0, 0);
1233 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1236 /* Check that we can communication on the JTAG chain + eventually we want to
1237 * be able to perform enumeration only after OpenOCD has started
1238 * telnet and GDB server
1240 * That would allow users to more easily perform any magic they need to before
1243 return jtag_init_inner(cmd_ctx
);
1246 int jtag_init(struct command_context_s
*cmd_ctx
)
1249 if ((retval
= jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1251 if (jtag_init_inner(cmd_ctx
) == ERROR_OK
)
1255 return jtag_init_reset(cmd_ctx
);
1258 void jtag_set_speed_khz(unsigned khz
)
1262 unsigned jtag_get_speed_khz(void)
1266 int jtag_config_khz(unsigned khz
)
1268 LOG_DEBUG("handle jtag khz");
1269 jtag_set_speed_khz(khz
);
1274 LOG_DEBUG("have interface set up");
1276 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1277 if (ERROR_OK
!= retval
)
1279 jtag_set_speed_khz(0);
1282 cur_speed
= speed_div1
;
1284 return jtag_set_speed(cur_speed
);
1287 int jtag_get_speed(void)
1292 int jtag_set_speed(int speed
)
1295 /* this command can be called during CONFIG,
1296 * in which case jtag isn't initialized */
1298 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1301 int jtag_get_speed_readable(int *speed
)
1303 return jtag
? jtag
->speed_div(jtag_get_speed(), speed
) : ERROR_OK
;
1307 void jtag_set_verify(bool enable
)
1309 jtag_verify
= enable
;
1312 bool jtag_will_verify()
1317 void jtag_set_verify_capture_ir(bool enable
)
1319 jtag_verify_capture_ir
= enable
;
1322 bool jtag_will_verify_capture_ir()
1324 return jtag_verify_capture_ir
;
1327 int jtag_power_dropout(int *dropout
)
1329 return jtag
->power_dropout(dropout
);
1332 int jtag_srst_asserted(int *srst_asserted
)
1334 return jtag
->srst_asserted(srst_asserted
);
1337 enum reset_types
jtag_get_reset_config(void)
1339 return jtag_reset_config
;
1341 void jtag_set_reset_config(enum reset_types type
)
1343 jtag_reset_config
= type
;
1346 int jtag_get_trst(void)
1350 int jtag_get_srst(void)
1355 void jtag_set_nsrst_delay(unsigned delay
)
1357 jtag_nsrst_delay
= delay
;
1359 unsigned jtag_get_nsrst_delay(void)
1361 return jtag_nsrst_delay
;
1363 void jtag_set_ntrst_delay(unsigned delay
)
1365 jtag_ntrst_delay
= delay
;
1367 unsigned jtag_get_ntrst_delay(void)
1369 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)