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 jtag_tap_t
*jtag_tap_by_string(const char *s
)
167 /* try by name first */
168 jtag_tap_t
*t
= jtag_all_taps();
171 if (0 == strcmp(t
->dotted_name
, s
))
176 /* no tap found by name, so try to parse the name as a number */
178 if (parse_uint(s
, &n
) != ERROR_OK
)
181 return jtag_tap_by_position(n
);
184 jtag_tap_t
*jtag_tap_by_jim_obj(Jim_Interp
*interp
, Jim_Obj
*o
)
186 const char *cp
= Jim_GetString(o
, NULL
);
187 jtag_tap_t
*t
= cp
? jtag_tap_by_string(cp
) : NULL
;
191 Jim_SetResult_sprintf(interp
, "Tap '%s' could not be found", cp
);
195 /* returns a pointer to the n-th device in the scan chain */
196 jtag_tap_t
*jtag_tap_by_position(unsigned n
)
198 jtag_tap_t
*t
= jtag_all_taps();
206 jtag_tap_t
* jtag_tap_next_enabled(jtag_tap_t
* p
)
208 p
= p
? p
->next_tap
: jtag_all_taps();
218 const char *jtag_tap_name(const jtag_tap_t
*tap
)
220 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
224 int jtag_register_event_callback(jtag_event_handler_t callback
, void *priv
)
226 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
228 if (callback
== NULL
)
230 return ERROR_INVALID_ARGUMENTS
;
235 while ((*callbacks_p
)->next
)
236 callbacks_p
= &((*callbacks_p
)->next
);
237 callbacks_p
= &((*callbacks_p
)->next
);
240 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
241 (*callbacks_p
)->callback
= callback
;
242 (*callbacks_p
)->priv
= priv
;
243 (*callbacks_p
)->next
= NULL
;
248 int jtag_unregister_event_callback(jtag_event_handler_t callback
, void *priv
)
250 jtag_event_callback_t
**callbacks_p
;
251 jtag_event_callback_t
**next
;
253 if (callback
== NULL
)
255 return ERROR_INVALID_ARGUMENTS
;
258 for (callbacks_p
= &jtag_event_callbacks
;
259 *callbacks_p
!= NULL
;
262 next
= &((*callbacks_p
)->next
);
264 if ((*callbacks_p
)->priv
!= priv
)
267 if ((*callbacks_p
)->callback
== callback
)
270 *callbacks_p
= *next
;
277 int jtag_call_event_callbacks(enum jtag_event event
)
279 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
281 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
285 jtag_event_callback_t
*next
;
287 /* callback may remove itself */
288 next
= callback
->next
;
289 callback
->callback(event
, callback
->priv
);
296 static void jtag_checks(void)
298 assert(jtag_trst
== 0);
301 static void jtag_prelude(tap_state_t state
)
305 assert(state
!= TAP_INVALID
);
307 cmd_queue_cur_state
= state
;
310 void jtag_alloc_in_value32(scan_field_t
*field
)
312 interface_jtag_alloc_in_value32(field
);
315 void jtag_add_ir_scan_noverify(int in_count
, const scan_field_t
*in_fields
,
320 int retval
= interface_jtag_add_ir_scan(in_count
, in_fields
, state
);
321 jtag_set_error(retval
);
325 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
327 if (jtag_verify
&&jtag_verify_capture_ir
)
329 /* 8 x 32 bit id's is enough for all invocations */
331 for (int j
= 0; j
< in_num_fields
; j
++)
333 /* if we are to run a verification of the ir scan, we need to get the input back.
334 * We may have to allocate space if the caller didn't ask for the input back.
336 in_fields
[j
].check_value
=in_fields
[j
].tap
->expected
;
337 in_fields
[j
].check_mask
=in_fields
[j
].tap
->expected_mask
;
339 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
342 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
346 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
,
351 int retval
= interface_jtag_add_plain_ir_scan(
352 in_num_fields
, in_fields
, state
);
353 jtag_set_error(retval
);
356 void jtag_add_callback(jtag_callback1_t f
, jtag_callback_data_t data0
)
358 interface_jtag_add_callback(f
, data0
);
361 void jtag_add_callback4(jtag_callback_t f
, jtag_callback_data_t data0
,
362 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
363 jtag_callback_data_t data3
)
365 interface_jtag_add_callback4(f
, data0
, data1
, data2
, data3
);
368 int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
, uint8_t *in_check_mask
, int num_bits
);
370 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
)
372 return jtag_check_value_inner((uint8_t *)data0
, (uint8_t *)data1
, (uint8_t *)data2
, (int)data3
);
375 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
376 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
378 for (int i
= 0; i
< in_num_fields
; i
++)
380 struct scan_field_s
*field
= &in_fields
[i
];
381 field
->allocated
= 0;
383 if (field
->check_value
|| field
->in_value
)
385 interface_jtag_add_scan_check_alloc(field
);
389 jtag_add_scan(in_num_fields
, in_fields
, state
);
391 for (int i
= 0; i
< in_num_fields
; i
++)
393 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
395 /* this is synchronous for a minidriver */
396 jtag_add_callback4(jtag_check_value_mask_callback
, (jtag_callback_data_t
)in_fields
[i
].in_value
,
397 (jtag_callback_data_t
)in_fields
[i
].check_value
,
398 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
399 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
401 if (in_fields
[i
].allocated
)
403 free(in_fields
[i
].in_value
);
405 if (in_fields
[i
].modified
)
407 in_fields
[i
].in_value
= NULL
;
412 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
416 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
419 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
424 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
430 retval
= interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
431 jtag_set_error(retval
);
434 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
440 retval
= interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
441 jtag_set_error(retval
);
444 void jtag_add_dr_out(jtag_tap_t
* tap
,
445 int num_fields
, const int* num_bits
, const uint32_t* value
,
446 tap_state_t end_state
)
448 assert(end_state
!= TAP_INVALID
);
450 cmd_queue_cur_state
= end_state
;
452 interface_jtag_add_dr_out(tap
,
453 num_fields
, num_bits
, value
,
457 void jtag_add_tlr(void)
459 jtag_prelude(TAP_RESET
);
460 jtag_set_error(interface_jtag_add_tlr());
461 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
464 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
466 tap_state_t cur_state
= cmd_queue_cur_state
;
468 /* the last state has to be a stable state */
469 if (!tap_is_state_stable(path
[num_states
- 1]))
471 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
472 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
476 for (int i
= 0; i
< num_states
; i
++)
478 if (path
[i
] == TAP_RESET
)
480 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
481 jtag_set_error(ERROR_JTAG_STATE_INVALID
);
485 if ( tap_state_transition(cur_state
, true) != path
[i
]
486 && tap_state_transition(cur_state
, false) != path
[i
])
488 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
489 tap_state_name(cur_state
), tap_state_name(path
[i
]));
490 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID
);
498 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
499 cmd_queue_cur_state
= path
[num_states
- 1];
502 int jtag_add_statemove(tap_state_t goal_state
)
504 tap_state_t cur_state
= cmd_queue_cur_state
;
506 LOG_DEBUG( "cur_state=%s goal_state=%s",
507 tap_state_name(cur_state
),
508 tap_state_name(goal_state
) );
511 if (goal_state
==cur_state
)
512 ; /* nothing to do */
513 else if ( goal_state
==TAP_RESET
)
517 else if ( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
519 unsigned tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
520 unsigned tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
521 tap_state_t moves
[8];
522 assert(tms_count
< DIM(moves
));
524 for (unsigned i
= 0; i
< tms_count
; i
++, tms_bits
>>= 1)
526 bool bit
= tms_bits
& 1;
528 cur_state
= tap_state_transition(cur_state
, bit
);
529 moves
[i
] = cur_state
;
532 jtag_add_pathmove(tms_count
, moves
);
534 else if ( tap_state_transition(cur_state
, true) == goal_state
535 || tap_state_transition(cur_state
, false) == goal_state
)
537 jtag_add_pathmove(1, &goal_state
);
546 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
549 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
553 void jtag_add_clocks(int num_cycles
)
555 if (!tap_is_state_stable(cmd_queue_cur_state
))
557 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
558 tap_state_name(cmd_queue_cur_state
));
559 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE
);
566 jtag_set_error(interface_jtag_add_clocks(num_cycles
));
570 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
572 int trst_with_tlr
= 0;
574 /* FIX!!! there are *many* different cases here. A better
575 * approach is needed for legal combinations of transitions...
577 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
578 (jtag_reset_config
& RESET_HAS_TRST
)&&
579 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
581 if (((req_tlr_or_trst
&&!jtag_trst
)||
582 (!req_tlr_or_trst
&&jtag_trst
))&&
583 ((req_srst
&&!jtag_srst
)||
584 (!req_srst
&&jtag_srst
)))
586 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
587 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
591 /* Make sure that jtag_reset_config allows the requested reset */
592 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
593 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
595 LOG_ERROR("BUG: requested reset would assert trst");
596 jtag_set_error(ERROR_FAIL
);
600 /* if TRST pulls SRST, we reset with TAP T-L-R */
601 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
606 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
608 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
609 jtag_set_error(ERROR_FAIL
);
615 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
627 jtag_srst
= req_srst
;
629 int retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
630 if (retval
!= ERROR_OK
)
632 jtag_set_error(retval
);
635 jtag_execute_queue();
639 LOG_DEBUG("SRST line asserted");
643 LOG_DEBUG("SRST line released");
644 if (jtag_nsrst_delay
)
645 jtag_add_sleep(jtag_nsrst_delay
* 1000);
650 LOG_DEBUG("JTAG reset with RESET instead of TRST");
651 jtag_set_end_state(TAP_RESET
);
658 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
659 * and inform possible listeners about this
661 LOG_DEBUG("TRST line asserted");
662 tap_set_state(TAP_RESET
);
663 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
667 if (jtag_ntrst_delay
)
668 jtag_add_sleep(jtag_ntrst_delay
* 1000);
672 tap_state_t
jtag_set_end_state(tap_state_t state
)
674 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
676 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
679 if (state
!= TAP_INVALID
)
680 cmd_queue_end_state
= state
;
681 return cmd_queue_end_state
;
684 tap_state_t
jtag_get_end_state(void)
686 return cmd_queue_end_state
;
689 void jtag_add_sleep(uint32_t us
)
691 /// @todo Here, keep_alive() appears to be a layering violation!!!
693 jtag_set_error(interface_jtag_add_sleep(us
));
696 int jtag_check_value_inner(uint8_t *captured
, uint8_t *in_check_value
, uint8_t *in_check_mask
, int num_bits
)
698 int retval
= ERROR_OK
;
700 int compare_failed
= 0;
703 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
705 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
708 /* An error handler could have caught the failing check
709 * only report a problem when there wasn't a handler, or if the handler
710 * acknowledged the error
713 LOG_WARNING("TAP %s:",
714 jtag_tap_name(field->tap));
718 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
719 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
723 char *in_check_mask_char
;
724 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
725 LOG_WARNING("value captured during scan didn't pass the requested check:");
726 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
727 captured_char
, in_check_value_char
, in_check_mask_char
);
728 free(in_check_mask_char
);
732 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
);
736 free(in_check_value_char
);
738 retval
= ERROR_JTAG_QUEUE_FAILED
;
745 void jtag_check_value_mask(scan_field_t
*field
, uint8_t *value
, uint8_t *mask
)
747 assert(field
->in_value
!= NULL
);
751 /* no checking to do */
755 jtag_execute_queue_noclear();
757 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
758 jtag_set_error(retval
);
763 int default_interface_jtag_execute_queue(void)
767 LOG_ERROR("No JTAG interface configured yet. "
768 "Issue 'init' command in startup scripts "
769 "before communicating with targets.");
773 return jtag
->execute_queue();
776 void jtag_execute_queue_noclear(void)
778 jtag_flush_queue_count
++;
779 jtag_set_error(interface_jtag_execute_queue());
782 int jtag_get_flush_queue_count(void)
784 return jtag_flush_queue_count
;
787 int jtag_execute_queue(void)
789 jtag_execute_queue_noclear();
790 return jtag_error_clear();
793 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
795 jtag_tap_t
*tap
= priv
;
799 if (event
== JTAG_TRST_ASSERTED
)
801 tap
->enabled
= !tap
->disabled_after_reset
;
803 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
810 void jtag_sleep(uint32_t us
)
812 alive_sleep(us
/1000);
815 /// maximum number of JTAG devices expected in the chain
816 #define JTAG_MAX_CHAIN_SIZE 20
818 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
819 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
820 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
822 static int jtag_examine_chain_execute(uint8_t *idcode_buffer
, unsigned num_idcode
)
824 scan_field_t field
= {
826 .num_bits
= num_idcode
* 32,
827 .out_value
= idcode_buffer
,
828 .in_value
= idcode_buffer
,
831 // initialize to the end of chain ID value
832 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
833 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
835 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
836 return jtag_execute_queue();
839 static bool jtag_examine_chain_check(uint8_t *idcodes
, unsigned count
)
841 uint8_t zero_check
= 0x0;
842 uint8_t one_check
= 0xff;
844 for (unsigned i
= 0; i
< count
* 4; i
++)
846 zero_check
|= idcodes
[i
];
847 one_check
&= idcodes
[i
];
850 /* if there wasn't a single non-zero bit or if all bits were one,
851 * the scan is not valid */
852 if (zero_check
== 0x00 || one_check
== 0xff)
854 LOG_ERROR("JTAG communication failure: check connection, "
855 "JTAG interface, target power etc.");
861 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
862 const char *name
, uint32_t idcode
)
864 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
865 "JTAG tap: %s %16.16s: 0x%08x "
866 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
868 (unsigned int)idcode
,
869 (unsigned int)EXTRACT_MFG(idcode
),
870 (unsigned int)EXTRACT_PART(idcode
),
871 (unsigned int)EXTRACT_VER(idcode
) );
874 static bool jtag_idcode_is_final(uint32_t idcode
)
876 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
880 * This helper checks that remaining bits in the examined chain data are
881 * all as expected, but a single JTAG device requires only 64 bits to be
882 * read back correctly. This can help identify and diagnose problems
883 * with the JTAG chain earlier, gives more helpful/explicit error messages.
885 static void jtag_examine_chain_end(uint8_t *idcodes
, unsigned count
, unsigned max
)
887 bool triggered
= false;
888 for ( ; count
< max
- 31; count
+= 32)
890 uint32_t idcode
= buf_get_u32(idcodes
, count
, 32);
891 // do not trigger the warning if the data looks good
892 if (!triggered
&& jtag_idcode_is_final(idcode
))
894 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
895 count
, (unsigned int)idcode
);
900 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
902 if (0 == tap
->expected_ids_cnt
)
904 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
906 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
907 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
912 /* Loop over the expected identification codes and test for a match */
914 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
916 if (tap
->idcode
== tap
->expected_ids
[ii
])
920 /* If none of the expected ids matched, log an error */
921 if (ii
!= tap
->expected_ids_cnt
)
923 LOG_INFO("JTAG Tap/device matched");
926 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
927 tap
->dotted_name
, tap
->idcode
);
928 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
931 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
932 ii
+ 1, tap
->expected_ids_cnt
);
933 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
934 tap
->dotted_name
, tap
->expected_ids
[ii
]);
939 /* Try to examine chain layout according to IEEE 1149.1 §12
941 int jtag_examine_chain(void)
943 uint8_t idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
944 unsigned device_count
= 0;
946 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
948 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
949 return ERROR_JTAG_INIT_FAILED
;
951 /* point at the 1st tap */
952 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
955 LOG_ERROR("JTAG: No taps enabled?");
956 return ERROR_JTAG_INIT_FAILED
;
959 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
961 uint32_t idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
962 if ((idcode
& 1) == 0)
964 /* LSB must not be 0, this indicates a device in bypass */
965 LOG_WARNING("Tap/Device does not have IDCODE");
973 * End of chain (invalid manufacturer ID) some devices, such
974 * as AVR will output all 1's instead of TDI input value at
977 if (jtag_idcode_is_final(idcode
))
979 jtag_examine_chain_end(idcode_buffer
,
980 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
984 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
985 tap
? tap
->dotted_name
: "(not-named)",
994 tap
->idcode
= idcode
;
996 // ensure the TAP ID does matches what was expected
997 if (!jtag_examine_chain_match_tap(tap
))
998 return ERROR_JTAG_INIT_FAILED
;
1000 tap
= jtag_tap_next_enabled(tap
);
1003 /* see if number of discovered devices matches configuration */
1004 if (device_count
!= jtag_tap_count_enabled())
1006 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1007 "does not match (enabled) configuration (%i), total taps: %d",
1008 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1009 LOG_ERROR("check the config file and ensure proper JTAG communication"
1010 " (connections, speed, ...)");
1011 return ERROR_JTAG_INIT_FAILED
;
1017 int jtag_validate_chain(void)
1020 int total_ir_length
= 0;
1021 uint8_t *ir_test
= NULL
;
1026 total_ir_length
= 0;
1028 tap
= jtag_tap_next_enabled(tap
);
1032 total_ir_length
+= tap
->ir_length
;
1035 total_ir_length
+= 2;
1036 ir_test
= malloc(CEIL(total_ir_length
, 8));
1037 buf_set_ones(ir_test
, total_ir_length
);
1040 field
.num_bits
= total_ir_length
;
1041 field
.out_value
= ir_test
;
1042 field
.in_value
= ir_test
;
1045 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1046 jtag_execute_queue();
1052 tap
= jtag_tap_next_enabled(tap
);
1057 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1060 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1061 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
);
1064 return ERROR_JTAG_INIT_FAILED
;
1066 chain_pos
+= tap
->ir_length
;
1069 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1072 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1073 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
);
1076 return ERROR_JTAG_INIT_FAILED
;
1085 void jtag_tap_init(jtag_tap_t
*tap
)
1087 assert(0 != tap
->ir_length
);
1089 tap
->expected
= malloc(tap
->ir_length
);
1090 tap
->expected_mask
= malloc(tap
->ir_length
);
1091 tap
->cur_instr
= malloc(tap
->ir_length
);
1093 /// @todo cope sanely with ir_length bigger than 32 bits
1094 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1095 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1096 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1098 // place TAP in bypass mode
1100 // register the reset callback for the TAP
1101 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1103 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1104 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1105 tap
->abs_chain_position
, tap
->ir_length
,
1106 (unsigned int)(tap
->ir_capture_value
), (unsigned int)(tap
->ir_capture_mask
));
1110 void jtag_tap_free(jtag_tap_t
*tap
)
1112 jtag_unregister_event_callback(&jtag_reset_callback
, tap
);
1114 /// @todo is anything missing? no memory leaks please
1115 free((void *)tap
->expected_ids
);
1116 free((void *)tap
->chip
);
1117 free((void *)tap
->tapname
);
1118 free((void *)tap
->dotted_name
);
1122 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1127 if (!jtag_interface
)
1129 /* nothing was previously specified by "interface" command */
1130 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1131 return ERROR_JTAG_INVALID_INTERFACE
;
1135 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1139 if (jtag_interface
->init() != ERROR_OK
)
1140 return ERROR_JTAG_INIT_FAILED
;
1142 jtag
= jtag_interface
;
1146 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1151 LOG_DEBUG("Init JTAG chain");
1153 tap
= jtag_tap_next_enabled(NULL
);
1155 LOG_ERROR("There are no enabled taps?");
1156 return ERROR_JTAG_INIT_FAILED
;
1160 if ((retval
=jtag_execute_queue()) != ERROR_OK
)
1163 /* examine chain first, as this could discover the real chain layout */
1164 if (jtag_examine_chain() != ERROR_OK
)
1166 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1169 if (jtag_validate_chain() != ERROR_OK
)
1171 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1177 int jtag_interface_quit(void)
1179 if (!jtag
|| !jtag
->quit
)
1182 // close the JTAG interface
1183 int result
= jtag
->quit();
1184 if (ERROR_OK
!= result
)
1185 LOG_ERROR("failed: %d", result
);
1191 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1195 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1198 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1200 /* Reset can happen after a power cycle.
1202 * Ideally we would only assert TRST or run RESET before the target reset.
1204 * However w/srst_pulls_trst, trst is asserted together with the target
1205 * reset whether we want it or not.
1207 * NB! Some targets have JTAG circuitry disabled until a
1208 * trst & srst has been asserted.
1210 * NB! here we assume nsrst/ntrst delay are sufficient!
1212 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1215 jtag_add_reset(1, 0); /* RESET or TRST */
1216 if (jtag_reset_config
& RESET_HAS_SRST
)
1218 jtag_add_reset(1, 1);
1219 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1220 jtag_add_reset(0, 1);
1222 jtag_add_reset(0, 0);
1223 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1226 /* Check that we can communication on the JTAG chain + eventually we want to
1227 * be able to perform enumeration only after OpenOCD has started
1228 * telnet and GDB server
1230 * That would allow users to more easily perform any magic they need to before
1233 return jtag_init_inner(cmd_ctx
);
1236 int jtag_init(struct command_context_s
*cmd_ctx
)
1239 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1241 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1245 return jtag_init_reset(cmd_ctx
);
1248 void jtag_set_speed_khz(unsigned khz
)
1252 unsigned jtag_get_speed_khz(void)
1256 int jtag_config_khz(unsigned khz
)
1258 LOG_DEBUG("handle jtag khz");
1259 jtag_set_speed_khz(khz
);
1264 LOG_DEBUG("have interface set up");
1266 int retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
1267 if (ERROR_OK
!= retval
)
1269 jtag_set_speed_khz(0);
1272 cur_speed
= speed_div1
;
1274 return jtag_set_speed(cur_speed
);
1277 int jtag_get_speed(void)
1282 int jtag_set_speed(int speed
)
1285 /* this command can be called during CONFIG,
1286 * in which case jtag isn't initialized */
1288 return jtag
? jtag
->speed(speed
) : ERROR_OK
;
1291 int jtag_get_speed_readable(int *speed
)
1293 return jtag
? jtag
->speed_div(jtag_get_speed(), speed
) : ERROR_OK
;
1297 void jtag_set_verify(bool enable
)
1299 jtag_verify
= enable
;
1302 bool jtag_will_verify()
1307 void jtag_set_verify_capture_ir(bool enable
)
1309 jtag_verify_capture_ir
= enable
;
1312 bool jtag_will_verify_capture_ir()
1314 return jtag_verify_capture_ir
;
1317 int jtag_power_dropout(int *dropout
)
1319 return jtag
->power_dropout(dropout
);
1322 int jtag_srst_asserted(int *srst_asserted
)
1324 return jtag
->srst_asserted(srst_asserted
);
1327 enum reset_types
jtag_get_reset_config(void)
1329 return jtag_reset_config
;
1331 void jtag_set_reset_config(enum reset_types type
)
1333 jtag_reset_config
= type
;
1336 int jtag_get_trst(void)
1340 int jtag_get_srst(void)
1345 void jtag_set_nsrst_delay(unsigned delay
)
1347 jtag_nsrst_delay
= delay
;
1349 unsigned jtag_get_nsrst_delay(void)
1351 return jtag_nsrst_delay
;
1353 void jtag_set_ntrst_delay(unsigned delay
)
1355 jtag_ntrst_delay
= delay
;
1357 unsigned jtag_get_ntrst_delay(void)
1359 return jtag_ntrst_delay
;