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 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
17 * This program is distributed in the hope that it will be useful, *
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
20 * GNU General Public License for more details. *
22 * You should have received a copy of the GNU General Public License *
23 * along with this program; if not, write to the *
24 * Free Software Foundation, Inc., *
25 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
26 ***************************************************************************/
32 #include "minidriver.h"
33 #include "interface.h"
40 /// The number of JTAG queue flushes (for profiling and debugging purposes).
41 static int jtag_flush_queue_count
;
43 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
44 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
);
46 /* note that this is not marked as static as it must be available from outside jtag.c for those
47 that implement the jtag_xxx() minidriver layer
49 int jtag_error
=ERROR_OK
;
51 char* jtag_event_strings
[] =
53 "JTAG controller reset (RESET or TRST)"
56 const Jim_Nvp nvp_jtag_tap_event
[] = {
57 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
58 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
60 { .name
= NULL
, .value
= -1 }
67 * List all TAPs that have been created.
69 static jtag_tap_t
*__jtag_all_taps
= NULL
;
71 * The number of TAPs in the __jtag_all_taps list, used to track the
72 * assigned chain position to new TAPs
74 static int jtag_num_taps
= 0;
76 enum reset_types jtag_reset_config
= RESET_NONE
;
77 tap_state_t cmd_queue_end_state
= TAP_RESET
;
78 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
80 int jtag_verify_capture_ir
= 1;
83 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
84 static int jtag_nsrst_delay
= 0; /* default to no nSRST delay */
85 static int jtag_ntrst_delay
= 0; /* default to no nTRST delay */
87 /* callbacks to inform high-level handlers about JTAG state changes */
88 jtag_event_callback_t
*jtag_event_callbacks
;
91 static int speed_khz
= 0;
92 /* flag if the kHz speed was defined */
93 static bool hasKHz
= false;
95 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
98 #if BUILD_ECOSBOARD == 1
99 extern jtag_interface_t zy1000_interface
;
100 #elif defined(BUILD_MINIDRIVER_DUMMY)
101 extern jtag_interface_t minidummy_interface
;
102 #else // standard drivers
103 #if BUILD_PARPORT == 1
104 extern jtag_interface_t parport_interface
;
108 extern jtag_interface_t dummy_interface
;
111 #if BUILD_FT2232_FTD2XX == 1
112 extern jtag_interface_t ft2232_interface
;
115 #if BUILD_FT2232_LIBFTDI == 1
116 extern jtag_interface_t ft2232_interface
;
119 #if BUILD_AMTJTAGACCEL == 1
120 extern jtag_interface_t amt_jtagaccel_interface
;
123 #if BUILD_EP93XX == 1
124 extern jtag_interface_t ep93xx_interface
;
127 #if BUILD_AT91RM9200 == 1
128 extern jtag_interface_t at91rm9200_interface
;
131 #if BUILD_GW16012 == 1
132 extern jtag_interface_t gw16012_interface
;
135 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
136 extern jtag_interface_t presto_interface
;
139 #if BUILD_USBPROG == 1
140 extern jtag_interface_t usbprog_interface
;
144 extern jtag_interface_t jlink_interface
;
147 #if BUILD_VSLLINK == 1
148 extern jtag_interface_t vsllink_interface
;
152 extern jtag_interface_t rlink_interface
;
155 #if BUILD_ARMJTAGEW == 1
156 extern jtag_interface_t armjtagew_interface
;
158 #endif // standard drivers
161 * The list of built-in JTAG interfaces, containing entries for those
162 * drivers that were enabled by the @c configure script.
164 * The list should be defined to contain either one minidriver interface
165 * or some number of standard driver interfaces, never both.
167 jtag_interface_t
*jtag_interfaces
[] = {
168 #if BUILD_ECOSBOARD == 1
170 #elif defined(BUILD_MINIDRIVER_DUMMY)
171 &minidummy_interface
,
172 #else // standard drivers
173 #if BUILD_PARPORT == 1
179 #if BUILD_FT2232_FTD2XX == 1
182 #if BUILD_FT2232_LIBFTDI == 1
185 #if BUILD_AMTJTAGACCEL == 1
186 &amt_jtagaccel_interface
,
188 #if BUILD_EP93XX == 1
191 #if BUILD_AT91RM9200 == 1
192 &at91rm9200_interface
,
194 #if BUILD_GW16012 == 1
197 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
200 #if BUILD_USBPROG == 1
206 #if BUILD_VSLLINK == 1
212 #if BUILD_ARMJTAGEW == 1
213 &armjtagew_interface
,
215 #endif // standard drivers
219 struct jtag_interface_s
*jtag
= NULL
;
222 static jtag_interface_t
*jtag_interface
= NULL
;
226 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
227 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
228 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
229 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
230 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
231 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
232 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
234 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
236 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
237 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
238 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
239 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
240 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
242 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
243 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
244 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
246 jtag_tap_t
*jtag_all_taps(void)
248 return __jtag_all_taps
;
251 int jtag_tap_count(void)
253 return jtag_num_taps
;
256 unsigned jtag_tap_count_enabled(void)
272 /// Append a new TAP to the chain of all taps.
273 static void jtag_tap_add(struct jtag_tap_s
*t
)
275 t
->abs_chain_position
= jtag_num_taps
++;
277 jtag_tap_t
**tap
= &__jtag_all_taps
;
279 tap
= &(*tap
)->next_tap
;
283 jtag_tap_t
*jtag_tap_by_string( const char *s
)
291 if( 0 == strcmp( t
->dotted_name
, s
) ){
297 /* backup plan is by number */
299 /* ok - is "s" a number? */
301 n
= strtol( s
, &cp
, 0 );
302 if( (s
!= cp
) && (*cp
== 0) ){
304 t
= jtag_tap_by_abs_position(n
);
310 jtag_tap_t
* jtag_tap_by_jim_obj( Jim_Interp
*interp
, Jim_Obj
*o
)
315 cp
= Jim_GetString( o
, NULL
);
320 t
= jtag_tap_by_string( cp
);
323 Jim_SetResult_sprintf(interp
,"Tap: %s is unknown", cp
);
328 /* returns a pointer to the n-th device in the scan chain */
329 jtag_tap_t
* jtag_tap_by_abs_position( int n
)
337 while( t
&& (n
> 0)) {
344 const char *jtag_tap_name(const jtag_tap_t
*tap
)
346 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
350 int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
)
352 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
354 if (callback
== NULL
)
356 return ERROR_INVALID_ARGUMENTS
;
361 while ((*callbacks_p
)->next
)
362 callbacks_p
= &((*callbacks_p
)->next
);
363 callbacks_p
= &((*callbacks_p
)->next
);
366 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
367 (*callbacks_p
)->callback
= callback
;
368 (*callbacks_p
)->priv
= priv
;
369 (*callbacks_p
)->next
= NULL
;
374 int jtag_unregister_event_callback(int (*callback
)(enum jtag_event event
, void *priv
))
376 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
378 if (callback
== NULL
)
380 return ERROR_INVALID_ARGUMENTS
;
385 jtag_event_callback_t
**next
= &((*callbacks_p
)->next
);
386 if ((*callbacks_p
)->callback
== callback
)
389 *callbacks_p
= *next
;
397 int jtag_call_event_callbacks(enum jtag_event event
)
399 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
401 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
405 callback
->callback(event
, callback
->priv
);
406 callback
= callback
->next
;
412 static void jtag_checks(void)
414 assert(jtag_trst
== 0);
417 static void jtag_prelude(tap_state_t state
)
421 assert(state
!=TAP_INVALID
);
423 cmd_queue_cur_state
= state
;
426 void jtag_alloc_in_value32(scan_field_t
*field
)
428 interface_jtag_alloc_in_value32(field
);
431 void jtag_add_ir_scan_noverify(int in_count
, const scan_field_t
*in_fields
,
436 int retval
= interface_jtag_add_ir_scan(in_count
, in_fields
, state
);
437 jtag_set_error(retval
);
442 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
444 * If the input field list contains an instruction value for a TAP then that is used
445 * otherwise the TAP is set to bypass.
447 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
450 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
452 if (jtag_verify
&&jtag_verify_capture_ir
)
454 /* 8 x 32 bit id's is enough for all invocations */
456 for (int j
= 0; j
< in_num_fields
; j
++)
458 /* if we are to run a verification of the ir scan, we need to get the input back.
459 * We may have to allocate space if the caller didn't ask for the input back.
461 in_fields
[j
].check_value
=in_fields
[j
].tap
->expected
;
462 in_fields
[j
].check_mask
=in_fields
[j
].tap
->expected_mask
;
464 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
467 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
472 * Duplicate the scan fields passed into the function into an IR SCAN command
474 * This function assumes that the caller handles extra fields for bypassed TAPs
477 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
,
482 int retval
= interface_jtag_add_plain_ir_scan(
483 in_num_fields
, in_fields
, state
);
484 jtag_set_error(retval
);
487 void jtag_add_callback(jtag_callback1_t f
, u8
*in
)
489 interface_jtag_add_callback(f
, in
);
492 void jtag_add_callback4(jtag_callback_t f
, u8
*in
,
493 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
494 jtag_callback_data_t data3
)
496 interface_jtag_add_callback4(f
, in
, data1
, data2
, data3
);
499 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
);
501 static int jtag_check_value_mask_callback(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
503 return jtag_check_value_inner(in
, (u8
*)data1
, (u8
*)data2
, (int)data3
);
506 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
507 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
509 for (int i
= 0; i
< in_num_fields
; i
++)
511 struct scan_field_s
*field
= &in_fields
[i
];
512 field
->allocated
= 0;
514 if (field
->check_value
|| field
->in_value
)
516 interface_jtag_add_scan_check_alloc(field
);
520 jtag_add_scan(in_num_fields
, in_fields
, state
);
522 for (int i
= 0; i
< in_num_fields
; i
++)
524 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
526 /* this is synchronous for a minidriver */
527 jtag_add_callback4(jtag_check_value_mask_callback
, in_fields
[i
].in_value
,
528 (jtag_callback_data_t
)in_fields
[i
].check_value
,
529 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
530 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
532 if (in_fields
[i
].allocated
)
534 free(in_fields
[i
].in_value
);
536 if (in_fields
[i
].modified
)
538 in_fields
[i
].in_value
= NULL
;
543 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
547 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
550 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
556 * Generate a DR SCAN using the fields passed to the function.
557 * For connected TAPs, the function checks in_fields and uses fields
558 * specified there. For bypassed TAPs, the function generates a dummy
559 * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan().
561 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
567 retval
= interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
568 jtag_set_error(retval
);
572 * Duplicate the scan fields passed into the function into a DR SCAN
573 * command. Unlike jtag_add_dr_scan(), this function assumes that the
574 * caller handles extra fields for bypassed TAPs.
576 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
582 retval
= interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
583 jtag_set_error(retval
);
586 void jtag_add_dr_out(jtag_tap_t
* tap
,
587 int num_fields
, const int* num_bits
, const u32
* value
,
588 tap_state_t end_state
)
590 assert(end_state
!= TAP_INVALID
);
592 cmd_queue_cur_state
= end_state
;
594 interface_jtag_add_dr_out(tap
,
595 num_fields
, num_bits
, value
,
599 void jtag_add_tlr(void)
601 jtag_prelude(TAP_RESET
);
602 jtag_set_error(interface_jtag_add_tlr());
603 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
606 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
608 tap_state_t cur_state
= cmd_queue_cur_state
;
610 /* the last state has to be a stable state */
611 if (!tap_is_state_stable(path
[num_states
- 1]))
613 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
617 for (int i
= 0; i
< num_states
; i
++)
619 if (path
[i
] == TAP_RESET
)
621 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
625 if ( tap_state_transition(cur_state
, true) != path
[i
]
626 && tap_state_transition(cur_state
, false) != path
[i
])
628 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
629 tap_state_name(cur_state
), tap_state_name(path
[i
]));
637 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
638 cmd_queue_cur_state
= path
[num_states
- 1];
641 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
647 /* executed by sw or hw fifo */
648 retval
=interface_jtag_add_runtest(num_cycles
, state
);
649 if (retval
!=ERROR_OK
)
654 void jtag_add_clocks( int num_cycles
)
658 if( !tap_is_state_stable(cmd_queue_cur_state
) )
660 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
661 tap_state_name(cmd_queue_cur_state
) );
662 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
670 retval
= interface_jtag_add_clocks(num_cycles
);
671 if (retval
!= ERROR_OK
)
676 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
678 int trst_with_tlr
= 0;
681 /* FIX!!! there are *many* different cases here. A better
682 * approach is needed for legal combinations of transitions...
684 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
685 (jtag_reset_config
& RESET_HAS_TRST
)&&
686 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
688 if (((req_tlr_or_trst
&&!jtag_trst
)||
689 (!req_tlr_or_trst
&&jtag_trst
))&&
690 ((req_srst
&&!jtag_srst
)||
691 (!req_srst
&&jtag_srst
)))
693 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
694 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
698 /* Make sure that jtag_reset_config allows the requested reset */
699 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
700 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
702 LOG_ERROR("BUG: requested reset would assert trst");
703 jtag_error
=ERROR_FAIL
;
707 /* if TRST pulls SRST, we reset with TAP T-L-R */
708 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
713 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
715 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
716 jtag_error
=ERROR_FAIL
;
722 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
734 jtag_srst
= req_srst
;
736 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
737 if (retval
!=ERROR_OK
)
742 jtag_execute_queue();
746 LOG_DEBUG("SRST line asserted");
750 LOG_DEBUG("SRST line released");
751 if (jtag_nsrst_delay
)
752 jtag_add_sleep(jtag_nsrst_delay
* 1000);
757 LOG_DEBUG("JTAG reset with RESET instead of TRST");
758 jtag_set_end_state(TAP_RESET
);
765 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
766 * and inform possible listeners about this
768 LOG_DEBUG("TRST line asserted");
769 tap_set_state(TAP_RESET
);
770 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
774 if (jtag_ntrst_delay
)
775 jtag_add_sleep(jtag_ntrst_delay
* 1000);
779 tap_state_t
jtag_set_end_state(tap_state_t state
)
781 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
783 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
786 if (state
!=TAP_INVALID
)
787 cmd_queue_end_state
= state
;
788 return cmd_queue_end_state
;
791 tap_state_t
jtag_get_end_state(void)
793 return cmd_queue_end_state
;
796 void jtag_add_sleep(u32 us
)
798 keep_alive(); /* we might be running on a very slow JTAG clk */
799 int retval
=interface_jtag_add_sleep(us
);
800 if (retval
!=ERROR_OK
)
805 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
807 int retval
= ERROR_OK
;
809 int compare_failed
= 0;
812 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
814 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
817 /* An error handler could have caught the failing check
818 * only report a problem when there wasn't a handler, or if the handler
819 * acknowledged the error
822 LOG_WARNING("TAP %s:",
823 jtag_tap_name(field->tap));
827 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
828 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
832 char *in_check_mask_char
;
833 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
834 LOG_WARNING("value captured during scan didn't pass the requested check:");
835 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
836 captured_char
, in_check_value_char
, in_check_mask_char
);
837 free(in_check_mask_char
);
841 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
);
845 free(in_check_value_char
);
847 retval
= ERROR_JTAG_QUEUE_FAILED
;
854 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
856 assert(field
->in_value
!= NULL
);
860 /* no checking to do */
864 jtag_execute_queue_noclear();
866 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
867 jtag_set_error(retval
);
872 int default_interface_jtag_execute_queue(void)
876 LOG_ERROR("No JTAG interface configured yet. "
877 "Issue 'init' command in startup scripts "
878 "before communicating with targets.");
882 return jtag
->execute_queue();
885 void jtag_execute_queue_noclear(void)
887 jtag_flush_queue_count
++;
888 jtag_set_error(interface_jtag_execute_queue());
891 int jtag_get_flush_queue_count(void)
893 return jtag_flush_queue_count
;
896 int jtag_execute_queue(void)
898 jtag_execute_queue_noclear();
899 return jtag_error_clear();
902 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
904 jtag_tap_t
*tap
= priv
;
908 if (event
== JTAG_TRST_ASSERTED
)
910 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
917 void jtag_sleep(u32 us
)
919 alive_sleep(us
/1000);
922 /// maximum number of JTAG devices expected in the chain
923 #define JTAG_MAX_CHAIN_SIZE 20
925 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
926 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
927 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
929 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
931 scan_field_t field
= {
933 .num_bits
= num_idcode
* 32,
934 .out_value
= idcode_buffer
,
935 .in_value
= idcode_buffer
,
938 // initialize to the end of chain ID value
939 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
940 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
942 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
943 return jtag_execute_queue();
946 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
951 for (unsigned i
= 0; i
< count
* 4; i
++)
953 zero_check
|= idcodes
[i
];
954 one_check
&= idcodes
[i
];
957 /* if there wasn't a single non-zero bit or if all bits were one,
958 * the scan is not valid */
959 if (zero_check
== 0x00 || one_check
== 0xff)
961 LOG_ERROR("JTAG communication failure: check connection, "
962 "JTAG interface, target power etc.");
968 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
969 const char *name
, u32 idcode
)
971 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
972 "JTAG tap: %s %16.16s: 0x%08x "
973 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
975 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
978 static bool jtag_idcode_is_final(u32 idcode
)
980 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
984 * This helper checks that remaining bits in the examined chain data are
985 * all as expected, but a single JTAG device requires only 64 bits to be
986 * read back correctly. This can help identify and diagnose problems
987 * with the JTAG chain earlier, gives more helpful/explicit error messages.
989 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
991 bool triggered
= false;
992 for ( ; count
< max
- 31; count
+= 32)
994 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
995 // do not trigger the warning if the data looks good
996 if (!triggered
&& jtag_idcode_is_final(idcode
))
998 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1004 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1006 if (0 == tap
->expected_ids_cnt
)
1008 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1010 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1011 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1016 /* Loop over the expected identification codes and test for a match */
1018 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1020 if (tap
->idcode
== tap
->expected_ids
[ii
])
1024 /* If none of the expected ids matched, log an error */
1025 if (ii
!= tap
->expected_ids_cnt
)
1027 LOG_INFO("JTAG Tap/device matched");
1030 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1031 tap
->dotted_name
, tap
->idcode
);
1032 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1035 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1036 ii
+ 1, tap
->expected_ids_cnt
);
1037 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1038 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1043 /* Try to examine chain layout according to IEEE 1149.1 §12
1045 static int jtag_examine_chain(void)
1047 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1048 unsigned device_count
= 0;
1050 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1052 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1053 return ERROR_JTAG_INIT_FAILED
;
1055 /* point at the 1st tap */
1056 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1059 LOG_ERROR("JTAG: No taps enabled?");
1060 return ERROR_JTAG_INIT_FAILED
;
1063 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1065 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1066 if ((idcode
& 1) == 0)
1068 /* LSB must not be 0, this indicates a device in bypass */
1069 LOG_WARNING("Tap/Device does not have IDCODE");
1077 * End of chain (invalid manufacturer ID) some devices, such
1078 * as AVR will output all 1's instead of TDI input value at
1081 if (jtag_idcode_is_final(idcode
))
1083 jtag_examine_chain_end(idcode_buffer
,
1084 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1088 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1089 tap
? tap
->dotted_name
: "(not-named)",
1098 tap
->idcode
= idcode
;
1100 // ensure the TAP ID does matches what was expected
1101 if (!jtag_examine_chain_match_tap(tap
))
1102 return ERROR_JTAG_INIT_FAILED
;
1104 tap
= jtag_tap_next_enabled(tap
);
1107 /* see if number of discovered devices matches configuration */
1108 if (device_count
!= jtag_tap_count_enabled())
1110 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1111 "does not match (enabled) configuration (%i), total taps: %d",
1112 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1113 LOG_ERROR("check the config file and ensure proper JTAG communication"
1114 " (connections, speed, ...)");
1115 return ERROR_JTAG_INIT_FAILED
;
1121 static int jtag_validate_chain(void)
1124 int total_ir_length
= 0;
1130 total_ir_length
= 0;
1132 tap
= jtag_tap_next_enabled(tap
);
1136 total_ir_length
+= tap
->ir_length
;
1139 total_ir_length
+= 2;
1140 ir_test
= malloc(CEIL(total_ir_length
, 8));
1141 buf_set_ones(ir_test
, total_ir_length
);
1144 field
.num_bits
= total_ir_length
;
1145 field
.out_value
= ir_test
;
1146 field
.in_value
= ir_test
;
1149 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1150 jtag_execute_queue();
1156 tap
= jtag_tap_next_enabled(tap
);
1161 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1164 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1165 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
);
1168 return ERROR_JTAG_INIT_FAILED
;
1170 chain_pos
+= tap
->ir_length
;
1173 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1176 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1177 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
);
1180 return ERROR_JTAG_INIT_FAILED
;
1188 enum jtag_tap_cfg_param
{
1192 static Jim_Nvp nvp_config_opts
[] = {
1193 { .name
= "-event", .value
= JCFG_EVENT
},
1195 { .name
= NULL
, .value
= -1 }
1198 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1204 /* parse config or cget options */
1205 while (goi
->argc
> 0) {
1206 Jim_SetEmptyResult (goi
->interp
);
1208 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1210 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1216 if (goi
->argc
== 0) {
1217 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1221 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1223 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1227 if (goi
->isconfigure
) {
1228 if (goi
->argc
!= 1) {
1229 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1233 if (goi
->argc
!= 0) {
1234 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1240 jtag_tap_event_action_t
*jteap
;
1242 jteap
= tap
->event_action
;
1243 /* replace existing? */
1245 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1248 jteap
= jteap
->next
;
1251 if (goi
->isconfigure
) {
1252 if (jteap
== NULL
) {
1254 jteap
= calloc(1, sizeof (*jteap
));
1256 jteap
->event
= n
->value
;
1257 Jim_GetOpt_Obj( goi
, &o
);
1259 Jim_DecrRefCount(interp
, jteap
->body
);
1261 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1262 Jim_IncrRefCount(jteap
->body
);
1264 /* add to head of event list */
1265 jteap
->next
= tap
->event_action
;
1266 tap
->event_action
= jteap
;
1267 Jim_SetEmptyResult(goi
->interp
);
1270 if (jteap
== NULL
) {
1271 Jim_SetEmptyResult(goi
->interp
);
1273 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1280 } /* while (goi->argc) */
1286 static void jtag_tap_init(jtag_tap_t
*tap
)
1288 assert(0 != tap
->ir_length
);
1290 tap
->expected
= malloc(tap
->ir_length
);
1291 tap
->expected_mask
= malloc(tap
->ir_length
);
1292 tap
->cur_instr
= malloc(tap
->ir_length
);
1294 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1295 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1296 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1298 // place TAP in bypass mode
1300 // register the reset callback for the TAP
1301 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1303 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1304 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1305 tap
->abs_chain_position
, tap
->ir_length
,
1306 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1310 static void jtag_tap_free(jtag_tap_t
*tap
)
1312 /// @todo is anything missing? no memory leaks please
1313 free((void *)tap
->expected_ids
);
1314 free((void *)tap
->chip
);
1315 free((void *)tap
->tapname
);
1316 free((void *)tap
->dotted_name
);
1320 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1329 const Jim_Nvp opts
[] = {
1330 #define NTAP_OPT_IRLEN 0
1331 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1332 #define NTAP_OPT_IRMASK 1
1333 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1334 #define NTAP_OPT_IRCAPTURE 2
1335 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1336 #define NTAP_OPT_ENABLED 3
1337 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1338 #define NTAP_OPT_DISABLED 4
1339 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1340 #define NTAP_OPT_EXPECTED_ID 5
1341 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1342 { .name
= NULL
, .value
= -1 },
1345 pTap
= malloc( sizeof(jtag_tap_t
) );
1346 memset( pTap
, 0, sizeof(*pTap
) );
1348 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1352 * we expect CHIP + TAP + OPTIONS
1354 if( goi
->argc
< 3 ){
1355 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1358 Jim_GetOpt_String( goi
, &cp
, NULL
);
1359 pTap
->chip
= strdup(cp
);
1361 Jim_GetOpt_String( goi
, &cp
, NULL
);
1362 pTap
->tapname
= strdup(cp
);
1364 /* name + dot + name + null */
1365 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1367 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1368 pTap
->dotted_name
= cp
;
1370 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1371 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1373 /* default is enabled */
1376 /* deal with options */
1377 #define NTREQ_IRLEN 1
1378 #define NTREQ_IRCAPTURE 2
1379 #define NTREQ_IRMASK 4
1381 /* clear them as we find them */
1382 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1385 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1387 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1390 LOG_DEBUG("Processing option: %s", n
->name
);
1392 case NTAP_OPT_ENABLED
:
1395 case NTAP_OPT_DISABLED
:
1398 case NTAP_OPT_EXPECTED_ID
:
1400 u32
*new_expected_ids
;
1402 e
= Jim_GetOpt_Wide( goi
, &w
);
1404 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1408 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1409 if (new_expected_ids
== NULL
) {
1410 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1414 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1416 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1418 free(pTap
->expected_ids
);
1419 pTap
->expected_ids
= new_expected_ids
;
1420 pTap
->expected_ids_cnt
++;
1423 case NTAP_OPT_IRLEN
:
1424 case NTAP_OPT_IRMASK
:
1425 case NTAP_OPT_IRCAPTURE
:
1426 e
= Jim_GetOpt_Wide( goi
, &w
);
1428 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1431 if( (w
< 0) || (w
> 0xffff) ){
1433 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1434 n
->name
, (int)(w
), (int)(w
));
1438 case NTAP_OPT_IRLEN
:
1439 pTap
->ir_length
= w
;
1440 reqbits
&= (~(NTREQ_IRLEN
));
1442 case NTAP_OPT_IRMASK
:
1443 pTap
->ir_capture_mask
= w
;
1444 reqbits
&= (~(NTREQ_IRMASK
));
1446 case NTAP_OPT_IRCAPTURE
:
1447 pTap
->ir_capture_value
= w
;
1448 reqbits
&= (~(NTREQ_IRCAPTURE
));
1451 } /* switch(n->value) */
1452 } /* while( goi->argc ) */
1454 /* Did all the required option bits get cleared? */
1457 jtag_tap_init(pTap
);
1461 Jim_SetResult_sprintf(goi
->interp
,
1462 "newtap: %s missing required parameters",
1464 jtag_tap_free(pTap
);
1468 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1474 struct command_context_s
*context
;
1478 JTAG_CMD_INIT_RESET
,
1481 JTAG_CMD_TAPDISABLE
,
1482 JTAG_CMD_TAPISENABLED
,
1487 const Jim_Nvp jtag_cmds
[] = {
1488 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1489 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1490 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1491 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1492 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1493 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1494 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1495 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1497 { .name
= NULL
, .value
= -1 },
1500 context
= Jim_GetAssocData(interp
, "context");
1501 /* go past the command */
1502 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1504 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1506 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1509 Jim_SetEmptyResult( goi
.interp
);
1511 case JTAG_CMD_INTERFACE
:
1512 /* return the name of the interface */
1513 /* TCL code might need to know the exact type... */
1514 /* FUTURE: we allow this as a means to "set" the interface. */
1515 if( goi
.argc
!= 0 ){
1516 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1519 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1521 case JTAG_CMD_INIT_RESET
:
1522 if( goi
.argc
!= 0 ){
1523 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1526 e
= jtag_init_reset(context
);
1527 if( e
!= ERROR_OK
){
1528 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1532 case JTAG_CMD_NEWTAP
:
1533 return jim_newtap_cmd( &goi
);
1535 case JTAG_CMD_TAPISENABLED
:
1536 case JTAG_CMD_TAPENABLE
:
1537 case JTAG_CMD_TAPDISABLE
:
1538 if( goi
.argc
!= 1 ){
1539 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1545 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1550 case JTAG_CMD_TAPISENABLED
:
1553 case JTAG_CMD_TAPENABLE
:
1554 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1558 case JTAG_CMD_TAPDISABLE
:
1559 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1564 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1571 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1578 Jim_GetOpt_Obj(&goi
, &o
);
1579 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1584 goi
.isconfigure
= 0;
1585 return jtag_tap_configure_cmd( &goi
, t
);
1589 case JTAG_CMD_CONFIGURE
:
1591 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1598 Jim_GetOpt_Obj(&goi
, &o
);
1599 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1604 goi
.isconfigure
= 1;
1605 return jtag_tap_configure_cmd( &goi
, t
);
1612 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1614 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1616 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1617 COMMAND_CONFIG
, "try to configure interface");
1618 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1619 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1620 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1621 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1622 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1623 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1624 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1625 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1627 "[none/trst_only/srst_only/trst_and_srst] [srst_pulls_trst/trst_pulls_srst] [combined/separate] [trst_push_pull/trst_open_drain] [srst_push_pull/srst_open_drain]");
1628 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1629 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1630 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1631 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1633 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1634 COMMAND_EXEC
, "print current scan chain configuration");
1636 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1637 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1638 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1639 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1640 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1641 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1642 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1643 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1645 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1646 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1647 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1648 COMMAND_ANY
, "verify value capture <enable|disable>");
1649 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1650 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1654 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1659 if (!jtag_interface
)
1661 /* nothing was previously specified by "interface" command */
1662 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1663 return ERROR_JTAG_INVALID_INTERFACE
;
1667 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1671 if (jtag_interface
->init() != ERROR_OK
)
1672 return ERROR_JTAG_INIT_FAILED
;
1674 jtag
= jtag_interface
;
1678 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1683 LOG_DEBUG("Init JTAG chain");
1685 tap
= jtag_tap_next_enabled(NULL
);
1687 LOG_ERROR("There are no enabled taps?");
1688 return ERROR_JTAG_INIT_FAILED
;
1692 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1695 /* examine chain first, as this could discover the real chain layout */
1696 if (jtag_examine_chain() != ERROR_OK
)
1698 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1701 if (jtag_validate_chain() != ERROR_OK
)
1703 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1709 int jtag_interface_quit(void)
1711 if (!jtag
|| !jtag
->quit
)
1714 // close the JTAG interface
1715 int result
= jtag
->quit();
1716 if (ERROR_OK
!= result
)
1717 LOG_ERROR("failed: %d", result
);
1723 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1727 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1730 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1732 /* Reset can happen after a power cycle.
1734 * Ideally we would only assert TRST or run RESET before the target reset.
1736 * However w/srst_pulls_trst, trst is asserted together with the target
1737 * reset whether we want it or not.
1739 * NB! Some targets have JTAG circuitry disabled until a
1740 * trst & srst has been asserted.
1742 * NB! here we assume nsrst/ntrst delay are sufficient!
1744 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1747 jtag_add_reset(1, 0); /* RESET or TRST */
1748 if (jtag_reset_config
& RESET_HAS_SRST
)
1750 jtag_add_reset(1, 1);
1751 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1752 jtag_add_reset(0, 1);
1754 jtag_add_reset(0, 0);
1755 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1758 /* Check that we can communication on the JTAG chain + eventually we want to
1759 * be able to perform enumeration only after OpenOCD has started
1760 * telnet and GDB server
1762 * That would allow users to more easily perform any magic they need to before
1765 return jtag_init_inner(cmd_ctx
);
1768 int jtag_init(struct command_context_s
*cmd_ctx
)
1771 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1773 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1777 return jtag_init_reset(cmd_ctx
);
1780 void jtag_set_speed_khz(unsigned khz
)
1784 unsigned jtag_get_speed_khz(void)
1789 static int default_khz(int khz
, int *jtag_speed
)
1791 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1795 static int default_speed_div(int speed
, int *khz
)
1797 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1801 static int default_power_dropout(int *dropout
)
1803 *dropout
=0; /* by default we can't detect power dropout */
1807 static int default_srst_asserted(int *srst_asserted
)
1809 *srst_asserted
=0; /* by default we can't detect srst asserted */
1813 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1818 /* check whether the interface is already configured */
1821 LOG_WARNING("Interface already configured, ignoring");
1825 /* interface name is a mandatory argument */
1826 if (argc
< 1 || args
[0][0] == '\0')
1828 return ERROR_COMMAND_SYNTAX_ERROR
;
1831 for (i
=0; jtag_interfaces
[i
]; i
++)
1833 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1835 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1840 jtag_interface
= jtag_interfaces
[i
];
1842 if (jtag_interface
->khz
== NULL
)
1844 jtag_interface
->khz
= default_khz
;
1846 if (jtag_interface
->speed_div
== NULL
)
1848 jtag_interface
->speed_div
= default_speed_div
;
1850 if (jtag_interface
->power_dropout
== NULL
)
1852 jtag_interface
->power_dropout
= default_power_dropout
;
1854 if (jtag_interface
->srst_asserted
== NULL
)
1856 jtag_interface
->srst_asserted
= default_srst_asserted
;
1863 /* no valid interface was found (i.e. the configuration option,
1864 * didn't match one of the compiled-in interfaces
1866 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1867 LOG_ERROR("compiled-in jtag interfaces:");
1868 for (i
= 0; jtag_interfaces
[i
]; i
++)
1870 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1873 return ERROR_JTAG_INVALID_INTERFACE
;
1876 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1880 Jim_Obj
*newargs
[ 10 ];
1883 * argv[-1] = command
1884 * argv[ 0] = ir length
1885 * argv[ 1] = ir capture
1886 * argv[ 2] = ir mask
1887 * argv[ 3] = not actually used by anything but in the docs
1891 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1894 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1895 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1899 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1900 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1901 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1902 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1904 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1905 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1906 sprintf( buf
, "chip%d", jtag_tap_count() );
1907 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1908 sprintf( buf
, "tap%d", jtag_tap_count() );
1909 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1910 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1911 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1912 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1913 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1914 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1915 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1917 command_print( cmd_ctx
, "NEW COMMAND:");
1918 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1919 Jim_GetString( newargs
[0], NULL
),
1920 Jim_GetString( newargs
[1], NULL
),
1921 Jim_GetString( newargs
[2], NULL
),
1922 Jim_GetString( newargs
[3], NULL
),
1923 Jim_GetString( newargs
[4], NULL
),
1924 Jim_GetString( newargs
[5], NULL
),
1925 Jim_GetString( newargs
[6], NULL
),
1926 Jim_GetString( newargs
[7], NULL
),
1927 Jim_GetString( newargs
[8], NULL
),
1928 Jim_GetString( newargs
[9], NULL
) );
1930 e
= jim_jtag_command( interp
, 10, newargs
);
1932 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1937 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1941 tap
= jtag_all_taps();
1942 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1943 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1946 u32 expected
, expected_mask
, cur_instr
, ii
;
1947 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1948 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1949 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1951 command_print(cmd_ctx
,
1952 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1953 tap
->abs_chain_position
,
1955 tap
->enabled
? 'Y' : 'n',
1957 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1963 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1964 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1965 tap
->expected_ids
[ii
]);
1968 tap
= tap
->next_tap
;
1974 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1980 return ERROR_COMMAND_SYNTAX_ERROR
;
1982 /* Original versions cared about the order of these tokens:
1983 * reset_config signals [combination [trst_type [srst_type]]]
1984 * They also clobbered the previous configuration even on error.
1986 * Here we don't care about the order, and only change values
1987 * which have been explicitly specified.
1989 for (; argc
; argc
--, args
++) {
1994 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
1995 if (strcmp(*args
, "none") == 0)
1997 else if (strcmp(*args
, "trst_only") == 0)
1998 tmp
= RESET_HAS_TRST
;
1999 else if (strcmp(*args
, "srst_only") == 0)
2000 tmp
= RESET_HAS_SRST
;
2001 else if (strcmp(*args
, "trst_and_srst") == 0)
2002 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2006 LOG_ERROR("extra reset_config %s spec (%s)",
2008 return ERROR_INVALID_ARGUMENTS
;
2013 /* combination (options for broken wiring) */
2014 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2015 if (strcmp(*args
, "separate") == 0)
2016 /* separate reset lines - default */;
2017 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2018 tmp
|= RESET_SRST_PULLS_TRST
;
2019 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2020 tmp
|= RESET_TRST_PULLS_SRST
;
2021 else if (strcmp(*args
, "combined") == 0)
2022 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2026 LOG_ERROR("extra reset_config %s spec (%s)",
2027 "combination", *args
);
2028 return ERROR_INVALID_ARGUMENTS
;
2033 /* trst_type (NOP without HAS_TRST) */
2034 m
= RESET_TRST_OPEN_DRAIN
;
2035 if (strcmp(*args
, "trst_open_drain") == 0)
2036 tmp
|= RESET_TRST_OPEN_DRAIN
;
2037 else if (strcmp(*args
, "trst_push_pull") == 0)
2038 /* push/pull from adapter - default */;
2042 LOG_ERROR("extra reset_config %s spec (%s)",
2043 "trst_type", *args
);
2044 return ERROR_INVALID_ARGUMENTS
;
2049 /* srst_type (NOP without HAS_SRST) */
2050 m
|= RESET_SRST_PUSH_PULL
;
2051 if (strcmp(*args
, "srst_push_pull") == 0)
2052 tmp
|= RESET_SRST_PUSH_PULL
;
2053 else if (strcmp(*args
, "srst_open_drain") == 0)
2054 /* open drain from adapter - default */;
2058 LOG_ERROR("extra reset_config %s spec (%s)",
2059 "srst_type", *args
);
2060 return ERROR_INVALID_ARGUMENTS
;
2065 /* caller provided nonsense; fail */
2066 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2067 return ERROR_INVALID_ARGUMENTS
;
2070 /* Remember the bits which were specified (mask)
2071 * and their new values (new_cfg).
2077 /* clear previous values of those bits, save new values */
2078 jtag_reset_config
&= ~mask
;
2079 jtag_reset_config
|= new_cfg
;
2084 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2085 char *cmd
, char **args
, int argc
)
2088 return ERROR_COMMAND_SYNTAX_ERROR
;
2090 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2091 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2095 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2096 char *cmd
, char **args
, int argc
)
2099 return ERROR_COMMAND_SYNTAX_ERROR
;
2101 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2102 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2106 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2108 int retval
= ERROR_OK
;
2111 return ERROR_COMMAND_SYNTAX_ERROR
;
2114 LOG_DEBUG("handle jtag speed");
2117 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2119 /* this command can be called during CONFIG,
2120 * in which case jtag isn't initialized */
2122 retval
= jtag
->speed(cur_speed
);
2124 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2129 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2132 return ERROR_COMMAND_SYNTAX_ERROR
;
2134 int retval
= ERROR_OK
;
2138 LOG_DEBUG("handle jtag khz");
2140 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2143 LOG_DEBUG("have interface set up");
2145 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2146 if (ERROR_OK
!= retval
)
2148 jtag_set_speed_khz(0);
2151 cur_speed
= jtag_speed
= speed_div1
;
2153 retval
= jtag
->speed(cur_speed
);
2159 cur_speed
= jtag_get_speed_khz();
2162 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2163 if (ERROR_OK
!= retval
)
2168 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2170 command_print(cmd_ctx
, "RCLK - adaptive");
2175 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
2176 char *cmd
, char **args
, int argc
)
2179 return ERROR_COMMAND_SYNTAX_ERROR
;
2182 if (args
[0][0] == '1')
2184 else if (args
[0][0] == '0')
2187 return ERROR_COMMAND_SYNTAX_ERROR
;
2190 if (args
[1][0] == '1')
2192 else if (args
[1][0] == '0')
2195 return ERROR_COMMAND_SYNTAX_ERROR
;
2197 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2198 return ERROR_JTAG_INIT_FAILED
;
2200 jtag_add_reset(trst
, srst
);
2201 jtag_execute_queue();
2206 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
2207 char *cmd
, char **args
, int argc
)
2210 return ERROR_COMMAND_SYNTAX_ERROR
;
2212 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2213 jtag_execute_queue();
2219 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2220 * should be stable ... and *NOT* a shift state, otherwise free-running
2221 * jtag clocks could change the values latched by the update state.
2223 static bool scan_is_safe(tap_state_t state
)
2238 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2241 scan_field_t
*fields
;
2243 tap_state_t endstate
;
2245 if ((argc
< 2) || (argc
% 2))
2247 return ERROR_COMMAND_SYNTAX_ERROR
;
2250 /* optional "-endstate" "statename" at the end of the arguments,
2251 * so that e.g. IRPAUSE can let us load the data register before
2252 * entering RUN/IDLE to execute the instruction we load here.
2254 endstate
= TAP_IDLE
;
2257 /* have at least one pair of numbers. */
2258 /* is last pair the magic text? */
2259 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2262 cpA
= args
[ argc
-1 ];
2263 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2264 cpS
= tap_state_name( endstate
);
2265 if( 0 == strcmp( cpA
, cpS
) ){
2269 if( endstate
>= TAP_NUM_STATES
){
2270 return ERROR_COMMAND_SYNTAX_ERROR
;
2272 if (!scan_is_safe(endstate
))
2273 LOG_WARNING("irscan with unsafe "
2274 "endstate \"%s\"", cpA
);
2275 /* found - remove the last 2 args */
2281 int num_fields
= argc
/ 2;
2283 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2285 for (i
= 0; i
< num_fields
; i
++)
2287 tap
= jtag_tap_by_string( args
[i
*2] );
2290 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2293 int field_size
= tap
->ir_length
;
2294 fields
[i
].tap
= tap
;
2295 fields
[i
].num_bits
= field_size
;
2296 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2297 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2298 fields
[i
].in_value
= NULL
;
2301 /* did we have an endstate? */
2302 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2304 int retval
=jtag_execute_queue();
2306 for (i
= 0; i
< num_fields
; i
++)
2307 free(fields
[i
].out_value
);
2314 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2317 scan_field_t
*fields
;
2319 int field_count
= 0;
2322 tap_state_t endstate
;
2325 * args[2] = num_bits
2326 * args[3] = hex string
2327 * ... repeat num bits and hex string ...
2330 * args[N-2] = "-endstate"
2331 * args[N-1] = statename
2333 if ((argc
< 4) || ((argc
% 2)!=0))
2335 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2339 endstate
= TAP_IDLE
;
2341 /* validate arguments as numbers */
2343 for (i
= 2; i
< argc
; i
+=2)
2348 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2349 /* If valid - try next arg */
2354 /* Not valid.. are we at the end? */
2355 if ( ((i
+2) != argc
) ){
2356 /* nope, then error */
2360 /* it could be: "-endstate FOO"
2361 * e.g. DRPAUSE so we can issue more instructions
2362 * before entering RUN/IDLE and executing them.
2365 /* get arg as a string. */
2366 cp
= Jim_GetString( args
[i
], NULL
);
2367 /* is it the magic? */
2368 if( 0 == strcmp( "-endstate", cp
) ){
2369 /* is the statename valid? */
2370 cp
= Jim_GetString( args
[i
+1], NULL
);
2372 /* see if it is a valid state name */
2373 endstate
= tap_state_by_name(cp
);
2375 /* update the error message */
2376 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2378 if (!scan_is_safe(endstate
))
2379 LOG_WARNING("drscan with unsafe "
2380 "endstate \"%s\"", cp
);
2382 /* valid - so clear the error */
2384 /* and remove the last 2 args */
2389 /* Still an error? */
2391 return e
; /* too bad */
2393 } /* validate args */
2395 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2400 num_fields
=(argc
-2)/2;
2401 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2402 for (i
= 2; i
< argc
; i
+=2)
2408 Jim_GetLong(interp
, args
[i
], &bits
);
2409 str
= Jim_GetString(args
[i
+1], &len
);
2411 fields
[field_count
].tap
= tap
;
2412 fields
[field_count
].num_bits
= bits
;
2413 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2414 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2415 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2419 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2421 retval
= jtag_execute_queue();
2422 if (retval
!= ERROR_OK
)
2424 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2429 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2430 for (i
= 2; i
< argc
; i
+=2)
2435 Jim_GetLong(interp
, args
[i
], &bits
);
2436 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2437 free(fields
[field_count
].out_value
);
2439 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2444 Jim_SetResult(interp
, list
);
2452 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2454 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2460 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2464 if (strcmp(args
[0], "enable") == 0)
2466 jtag_verify_capture_ir
= 1;
2468 else if (strcmp(args
[0], "disable") == 0)
2470 jtag_verify_capture_ir
= 0;
2473 return ERROR_COMMAND_SYNTAX_ERROR
;
2475 } else if (argc
!= 0)
2477 return ERROR_COMMAND_SYNTAX_ERROR
;
2480 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2485 void jtag_set_verify(bool enable
)
2487 jtag_verify
= enable
;
2490 bool jtag_will_verify()
2495 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2498 return ERROR_COMMAND_SYNTAX_ERROR
;
2502 if (strcmp(args
[0], "enable") == 0)
2503 jtag_set_verify(true);
2504 else if (strcmp(args
[0], "disable") == 0)
2505 jtag_set_verify(false);
2507 return ERROR_COMMAND_SYNTAX_ERROR
;
2510 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2511 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2517 int jtag_power_dropout(int *dropout
)
2519 return jtag
->power_dropout(dropout
);
2522 int jtag_srst_asserted(int *srst_asserted
)
2524 return jtag
->srst_asserted(srst_asserted
);
2527 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2529 jtag_tap_event_action_t
* jteap
;
2532 jteap
= tap
->event_action
;
2536 if (jteap
->event
== e
) {
2538 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2541 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2542 Jim_GetString(jteap
->body
, NULL
) );
2543 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2544 Jim_PrintErrorMessage(interp
);
2548 jteap
= jteap
->next
;
2552 LOG_DEBUG( "event %d %s - no action",
2554 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2558 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2561 return ERROR_COMMAND_SYNTAX_ERROR
;
2566 if (strcmp(args
[0], "short") == 0)
2567 use_new_table
= true;
2568 else if (strcmp(args
[0], "long") == 0)
2569 use_new_table
= false;
2571 return ERROR_COMMAND_SYNTAX_ERROR
;
2573 tap_use_new_tms_table(use_new_table
);
2576 command_print(cmd_ctx
, "tms sequence is %s",
2577 tap_uses_new_tms_table() ? "short": "long");
2583 * Function jtag_add_statemove
2584 * moves from the current state to the goal \a state. This needs
2585 * to be handled according to the xsvf spec, see the XSTATE command
2588 int jtag_add_statemove(tap_state_t goal_state
)
2590 int retval
= ERROR_OK
;
2592 tap_state_t moves
[8];
2593 tap_state_t cur_state
= cmd_queue_cur_state
;
2598 LOG_DEBUG( "cur_state=%s goal_state=%s",
2599 tap_state_name(cur_state
),
2600 tap_state_name(goal_state
) );
2603 /* From the XSVF spec, pertaining to XSTATE:
2605 For special states known as stable states (Test-Logic-Reset,
2606 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2607 predefined TAP state paths when the starting state is a stable state and
2608 when the XSTATE specifies a new stable state (see the STATE command in
2609 the [Ref 5] for the TAP state paths between stable states). For
2610 non-stable states, XSTATE should specify a state that is only one TAP
2611 state transition distance from the current TAP state to avoid undefined
2612 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2613 transition the TAP through a specific state path.
2616 if (goal_state
==cur_state
)
2617 ; /* nothing to do */
2619 else if( goal_state
==TAP_RESET
)
2624 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2626 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2627 spec, then this code is not fully conformant to the xsvf spec. This
2628 puts a burden on tap_get_tms_path() function from the xsvf spec.
2629 If in doubt, you should confirm that that burden is being met.
2632 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2633 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2635 assert( (unsigned) tms_count
< DIM(moves
) );
2637 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2639 bool bit
= tms_bits
& 1;
2641 cur_state
= tap_state_transition(cur_state
, bit
);
2642 moves
[i
] = cur_state
;
2645 jtag_add_pathmove(tms_count
, moves
);
2648 /* else state must be immediately reachable in one clock cycle, and does not
2649 need to be a stable state.
2651 else if( tap_state_transition(cur_state
, true) == goal_state
2652 || tap_state_transition(cur_state
, false) == goal_state
)
2654 /* move a single state */
2655 moves
[0] = goal_state
;
2656 jtag_add_pathmove( 1, moves
);
2661 retval
= ERROR_FAIL
;
2667 void jtag_set_nsrst_delay(unsigned delay
)
2669 jtag_nsrst_delay
= delay
;
2671 unsigned jtag_get_nsrst_delay(void)
2673 return jtag_nsrst_delay
;
2675 void jtag_set_ntrst_delay(unsigned delay
)
2677 jtag_ntrst_delay
= delay
;
2679 unsigned jtag_get_ntrst_delay(void)
2681 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)