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_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
436 retval
=interface_jtag_add_ir_scan(in_num_fields
, in_fields
, state
);
437 if (retval
!=ERROR_OK
)
444 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
446 * If the input field list contains an instruction value for a TAP then that is used
447 * otherwise the TAP is set to bypass.
449 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
452 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
454 if (jtag_verify
&&jtag_verify_capture_ir
)
456 /* 8 x 32 bit id's is enough for all invocations */
458 for (int j
= 0; j
< in_num_fields
; j
++)
460 /* if we are to run a verification of the ir scan, we need to get the input back.
461 * We may have to allocate space if the caller didn't ask for the input back.
463 in_fields
[j
].check_value
=in_fields
[j
].tap
->expected
;
464 in_fields
[j
].check_mask
=in_fields
[j
].tap
->expected_mask
;
466 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
469 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
474 * Duplicate the scan fields passed into the function into an IR SCAN command
476 * This function assumes that the caller handles extra fields for bypassed TAPs
479 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
485 retval
=interface_jtag_add_plain_ir_scan(in_num_fields
, in_fields
, state
);
486 if (retval
!=ERROR_OK
)
490 void jtag_add_callback(jtag_callback1_t f
, u8
*in
)
492 interface_jtag_add_callback(f
, in
);
495 void jtag_add_callback4(jtag_callback_t f
, u8
*in
,
496 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
497 jtag_callback_data_t data3
)
499 interface_jtag_add_callback4(f
, in
, data1
, data2
, data3
);
502 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
);
504 static int jtag_check_value_mask_callback(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
506 return jtag_check_value_inner(in
, (u8
*)data1
, (u8
*)data2
, (int)data3
);
509 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
510 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
512 for (int i
= 0; i
< in_num_fields
; i
++)
514 struct scan_field_s
*field
= &in_fields
[i
];
515 field
->allocated
= 0;
517 if (field
->check_value
|| field
->in_value
)
519 interface_jtag_add_scan_check_alloc(field
);
523 jtag_add_scan(in_num_fields
, in_fields
, state
);
525 for (int i
= 0; i
< in_num_fields
; i
++)
527 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
529 /* this is synchronous for a minidriver */
530 jtag_add_callback4(jtag_check_value_mask_callback
, in_fields
[i
].in_value
,
531 (jtag_callback_data_t
)in_fields
[i
].check_value
,
532 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
533 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
535 if (in_fields
[i
].allocated
)
537 free(in_fields
[i
].in_value
);
539 if (in_fields
[i
].modified
)
541 in_fields
[i
].in_value
= NULL
;
546 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
550 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
553 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
559 * Generate a DR SCAN using the fields passed to the function
561 * For not bypassed TAPs the function checks in_fields and uses fields specified there.
562 * For bypassed TAPs the function generates a dummy 1bit field.
564 * The bypass status of TAPs is set by jtag_add_ir_scan().
567 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
573 retval
=interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
574 if (retval
!=ERROR_OK
)
581 * Duplicate the scan fields passed into the function into a DR SCAN command
583 * This function assumes that the caller handles extra fields for bypassed TAPs
586 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
592 retval
=interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
593 if (retval
!=ERROR_OK
)
597 void jtag_add_dr_out(jtag_tap_t
* tap
,
598 int num_fields
, const int* num_bits
, const u32
* value
,
599 tap_state_t end_state
)
601 assert(end_state
!= TAP_INVALID
);
603 cmd_queue_cur_state
= end_state
;
605 interface_jtag_add_dr_out(tap
,
606 num_fields
, num_bits
, value
,
610 void jtag_add_tlr(void)
612 jtag_prelude(TAP_RESET
);
615 retval
=interface_jtag_add_tlr();
616 if (retval
!=ERROR_OK
)
619 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
622 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
624 tap_state_t cur_state
= cmd_queue_cur_state
;
628 /* the last state has to be a stable state */
629 if (!tap_is_state_stable(path
[num_states
- 1]))
631 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
635 for (i
=0; i
<num_states
; i
++)
637 if (path
[i
] == TAP_RESET
)
639 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
643 if ( tap_state_transition(cur_state
, true) != path
[i
]
644 && tap_state_transition(cur_state
, false) != path
[i
])
646 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[i
]));
654 retval
= interface_jtag_add_pathmove(num_states
, path
);
655 cmd_queue_cur_state
= path
[num_states
- 1];
656 if (retval
!=ERROR_OK
)
660 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
666 /* executed by sw or hw fifo */
667 retval
=interface_jtag_add_runtest(num_cycles
, state
);
668 if (retval
!=ERROR_OK
)
673 void jtag_add_clocks( int num_cycles
)
677 if( !tap_is_state_stable(cmd_queue_cur_state
) )
679 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
680 tap_state_name(cmd_queue_cur_state
) );
681 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
689 retval
= interface_jtag_add_clocks(num_cycles
);
690 if (retval
!= ERROR_OK
)
695 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
697 int trst_with_tlr
= 0;
700 /* FIX!!! there are *many* different cases here. A better
701 * approach is needed for legal combinations of transitions...
703 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
704 (jtag_reset_config
& RESET_HAS_TRST
)&&
705 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
707 if (((req_tlr_or_trst
&&!jtag_trst
)||
708 (!req_tlr_or_trst
&&jtag_trst
))&&
709 ((req_srst
&&!jtag_srst
)||
710 (!req_srst
&&jtag_srst
)))
712 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
713 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
717 /* Make sure that jtag_reset_config allows the requested reset */
718 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
719 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
721 LOG_ERROR("BUG: requested reset would assert trst");
722 jtag_error
=ERROR_FAIL
;
726 /* if TRST pulls SRST, we reset with TAP T-L-R */
727 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
732 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
734 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
735 jtag_error
=ERROR_FAIL
;
741 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
753 jtag_srst
= req_srst
;
755 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
756 if (retval
!=ERROR_OK
)
761 jtag_execute_queue();
765 LOG_DEBUG("SRST line asserted");
769 LOG_DEBUG("SRST line released");
770 if (jtag_nsrst_delay
)
771 jtag_add_sleep(jtag_nsrst_delay
* 1000);
776 LOG_DEBUG("JTAG reset with RESET instead of TRST");
777 jtag_set_end_state(TAP_RESET
);
784 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
785 * and inform possible listeners about this
787 LOG_DEBUG("TRST line asserted");
788 tap_set_state(TAP_RESET
);
789 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
793 if (jtag_ntrst_delay
)
794 jtag_add_sleep(jtag_ntrst_delay
* 1000);
798 tap_state_t
jtag_set_end_state(tap_state_t state
)
800 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
802 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
805 if (state
!=TAP_INVALID
)
806 cmd_queue_end_state
= state
;
807 return cmd_queue_end_state
;
810 tap_state_t
jtag_get_end_state(void)
812 return cmd_queue_end_state
;
815 void jtag_add_sleep(u32 us
)
817 keep_alive(); /* we might be running on a very slow JTAG clk */
818 int retval
=interface_jtag_add_sleep(us
);
819 if (retval
!=ERROR_OK
)
824 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
826 int retval
= ERROR_OK
;
828 int compare_failed
= 0;
831 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
833 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
836 /* An error handler could have caught the failing check
837 * only report a problem when there wasn't a handler, or if the handler
838 * acknowledged the error
841 LOG_WARNING("TAP %s:",
842 jtag_tap_name(field->tap));
846 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
847 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
851 char *in_check_mask_char
;
852 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
853 LOG_WARNING("value captured during scan didn't pass the requested check:");
854 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
855 captured_char
, in_check_value_char
, in_check_mask_char
);
856 free(in_check_mask_char
);
860 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
);
864 free(in_check_value_char
);
866 retval
= ERROR_JTAG_QUEUE_FAILED
;
873 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
875 assert(field
->in_value
!= NULL
);
879 /* no checking to do */
883 jtag_execute_queue_noclear();
885 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
886 jtag_set_error(retval
);
891 int default_interface_jtag_execute_queue(void)
895 LOG_ERROR("No JTAG interface configured yet. "
896 "Issue 'init' command in startup scripts "
897 "before communicating with targets.");
901 return jtag
->execute_queue();
904 void jtag_execute_queue_noclear(void)
906 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
907 * E.g. a JTAG over TCP/IP or USB....
909 jtag_flush_queue_count
++;
911 int retval
=interface_jtag_execute_queue();
912 /* we keep the first error */
913 if ((jtag_error
==ERROR_OK
)&&(retval
!=ERROR_OK
))
919 int jtag_get_flush_queue_count(void)
921 return jtag_flush_queue_count
;
924 int jtag_execute_queue(void)
927 jtag_execute_queue_noclear();
933 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
935 jtag_tap_t
*tap
= priv
;
939 if (event
== JTAG_TRST_ASSERTED
)
941 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
948 void jtag_sleep(u32 us
)
950 alive_sleep(us
/1000);
953 /// maximum number of JTAG devices expected in the chain
954 #define JTAG_MAX_CHAIN_SIZE 20
956 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
957 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
958 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
960 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
962 scan_field_t field
= {
964 .num_bits
= num_idcode
* 32,
965 .out_value
= idcode_buffer
,
966 .in_value
= idcode_buffer
,
969 // initialize to the end of chain ID value
970 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
971 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
973 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
974 return jtag_execute_queue();
977 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
982 for (unsigned i
= 0; i
< count
* 4; i
++)
984 zero_check
|= idcodes
[i
];
985 one_check
&= idcodes
[i
];
988 /* if there wasn't a single non-zero bit or if all bits were one,
989 * the scan is not valid */
990 if (zero_check
== 0x00 || one_check
== 0xff)
992 LOG_ERROR("JTAG communication failure: check connection, "
993 "JTAG interface, target power etc.");
999 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
1000 const char *name
, u32 idcode
)
1002 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
1003 "JTAG tap: %s %16.16s: 0x%08x "
1004 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1006 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
1009 static bool jtag_idcode_is_final(u32 idcode
)
1011 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
1015 * This helper checks that remaining bits in the examined chain data are
1016 * all as expected, but a single JTAG device requires only 64 bits to be
1017 * read back correctly. This can help identify and diagnose problems
1018 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1020 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
1022 bool triggered
= false;
1023 for ( ; count
< max
- 31; count
+= 32)
1025 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
1026 // do not trigger the warning if the data looks good
1027 if (!triggered
&& jtag_idcode_is_final(idcode
))
1029 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1035 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1037 if (0 == tap
->expected_ids_cnt
)
1039 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1041 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1042 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1047 /* Loop over the expected identification codes and test for a match */
1049 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1051 if (tap
->idcode
== tap
->expected_ids
[ii
])
1055 /* If none of the expected ids matched, log an error */
1056 if (ii
!= tap
->expected_ids_cnt
)
1058 LOG_INFO("JTAG Tap/device matched");
1061 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1062 tap
->dotted_name
, tap
->idcode
);
1063 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1066 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1067 ii
+ 1, tap
->expected_ids_cnt
);
1068 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1069 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1074 /* Try to examine chain layout according to IEEE 1149.1 §12
1076 static int jtag_examine_chain(void)
1078 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1079 unsigned device_count
= 0;
1081 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1083 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1084 return ERROR_JTAG_INIT_FAILED
;
1086 /* point at the 1st tap */
1087 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1090 LOG_ERROR("JTAG: No taps enabled?");
1091 return ERROR_JTAG_INIT_FAILED
;
1094 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1096 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1097 if ((idcode
& 1) == 0)
1099 /* LSB must not be 0, this indicates a device in bypass */
1100 LOG_WARNING("Tap/Device does not have IDCODE");
1108 * End of chain (invalid manufacturer ID) some devices, such
1109 * as AVR will output all 1's instead of TDI input value at
1112 if (jtag_idcode_is_final(idcode
))
1114 jtag_examine_chain_end(idcode_buffer
,
1115 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1119 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1120 tap
? tap
->dotted_name
: "(not-named)",
1129 tap
->idcode
= idcode
;
1131 // ensure the TAP ID does matches what was expected
1132 if (!jtag_examine_chain_match_tap(tap
))
1133 return ERROR_JTAG_INIT_FAILED
;
1135 tap
= jtag_tap_next_enabled(tap
);
1138 /* see if number of discovered devices matches configuration */
1139 if (device_count
!= jtag_tap_count_enabled())
1141 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1142 "does not match (enabled) configuration (%i), total taps: %d",
1143 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1144 LOG_ERROR("check the config file and ensure proper JTAG communication"
1145 " (connections, speed, ...)");
1146 return ERROR_JTAG_INIT_FAILED
;
1152 static int jtag_validate_chain(void)
1155 int total_ir_length
= 0;
1161 total_ir_length
= 0;
1163 tap
= jtag_tap_next_enabled(tap
);
1167 total_ir_length
+= tap
->ir_length
;
1170 total_ir_length
+= 2;
1171 ir_test
= malloc(CEIL(total_ir_length
, 8));
1172 buf_set_ones(ir_test
, total_ir_length
);
1175 field
.num_bits
= total_ir_length
;
1176 field
.out_value
= ir_test
;
1177 field
.in_value
= ir_test
;
1180 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1181 jtag_execute_queue();
1187 tap
= jtag_tap_next_enabled(tap
);
1192 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1195 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1196 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
);
1199 return ERROR_JTAG_INIT_FAILED
;
1201 chain_pos
+= tap
->ir_length
;
1204 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1207 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1208 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
);
1211 return ERROR_JTAG_INIT_FAILED
;
1219 enum jtag_tap_cfg_param
{
1223 static Jim_Nvp nvp_config_opts
[] = {
1224 { .name
= "-event", .value
= JCFG_EVENT
},
1226 { .name
= NULL
, .value
= -1 }
1229 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1235 /* parse config or cget options */
1236 while (goi
->argc
> 0) {
1237 Jim_SetEmptyResult (goi
->interp
);
1239 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1241 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1247 if (goi
->argc
== 0) {
1248 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1252 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1254 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1258 if (goi
->isconfigure
) {
1259 if (goi
->argc
!= 1) {
1260 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1264 if (goi
->argc
!= 0) {
1265 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1271 jtag_tap_event_action_t
*jteap
;
1273 jteap
= tap
->event_action
;
1274 /* replace existing? */
1276 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1279 jteap
= jteap
->next
;
1282 if (goi
->isconfigure
) {
1283 if (jteap
== NULL
) {
1285 jteap
= calloc(1, sizeof (*jteap
));
1287 jteap
->event
= n
->value
;
1288 Jim_GetOpt_Obj( goi
, &o
);
1290 Jim_DecrRefCount(interp
, jteap
->body
);
1292 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1293 Jim_IncrRefCount(jteap
->body
);
1295 /* add to head of event list */
1296 jteap
->next
= tap
->event_action
;
1297 tap
->event_action
= jteap
;
1298 Jim_SetEmptyResult(goi
->interp
);
1301 if (jteap
== NULL
) {
1302 Jim_SetEmptyResult(goi
->interp
);
1304 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1311 } /* while (goi->argc) */
1317 static void jtag_tap_init(jtag_tap_t
*tap
)
1319 assert(0 != tap
->ir_length
);
1321 tap
->expected
= malloc(tap
->ir_length
);
1322 tap
->expected_mask
= malloc(tap
->ir_length
);
1323 tap
->cur_instr
= malloc(tap
->ir_length
);
1325 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1326 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1327 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1329 // place TAP in bypass mode
1331 // register the reset callback for the TAP
1332 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1334 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1335 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1336 tap
->abs_chain_position
, tap
->ir_length
,
1337 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1341 static void jtag_tap_free(jtag_tap_t
*tap
)
1343 /// @todo is anything missing? no memory leaks please
1344 free((void *)tap
->expected_ids
);
1345 free((void *)tap
->chip
);
1346 free((void *)tap
->tapname
);
1347 free((void *)tap
->dotted_name
);
1351 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1360 const Jim_Nvp opts
[] = {
1361 #define NTAP_OPT_IRLEN 0
1362 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1363 #define NTAP_OPT_IRMASK 1
1364 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1365 #define NTAP_OPT_IRCAPTURE 2
1366 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1367 #define NTAP_OPT_ENABLED 3
1368 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1369 #define NTAP_OPT_DISABLED 4
1370 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1371 #define NTAP_OPT_EXPECTED_ID 5
1372 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1373 { .name
= NULL
, .value
= -1 },
1376 pTap
= malloc( sizeof(jtag_tap_t
) );
1377 memset( pTap
, 0, sizeof(*pTap
) );
1379 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1383 * we expect CHIP + TAP + OPTIONS
1385 if( goi
->argc
< 3 ){
1386 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1389 Jim_GetOpt_String( goi
, &cp
, NULL
);
1390 pTap
->chip
= strdup(cp
);
1392 Jim_GetOpt_String( goi
, &cp
, NULL
);
1393 pTap
->tapname
= strdup(cp
);
1395 /* name + dot + name + null */
1396 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1398 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1399 pTap
->dotted_name
= cp
;
1401 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1402 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1404 /* default is enabled */
1407 /* deal with options */
1408 #define NTREQ_IRLEN 1
1409 #define NTREQ_IRCAPTURE 2
1410 #define NTREQ_IRMASK 4
1412 /* clear them as we find them */
1413 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1416 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1418 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1421 LOG_DEBUG("Processing option: %s", n
->name
);
1423 case NTAP_OPT_ENABLED
:
1426 case NTAP_OPT_DISABLED
:
1429 case NTAP_OPT_EXPECTED_ID
:
1431 u32
*new_expected_ids
;
1433 e
= Jim_GetOpt_Wide( goi
, &w
);
1435 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1439 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1440 if (new_expected_ids
== NULL
) {
1441 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1445 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1447 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1449 free(pTap
->expected_ids
);
1450 pTap
->expected_ids
= new_expected_ids
;
1451 pTap
->expected_ids_cnt
++;
1454 case NTAP_OPT_IRLEN
:
1455 case NTAP_OPT_IRMASK
:
1456 case NTAP_OPT_IRCAPTURE
:
1457 e
= Jim_GetOpt_Wide( goi
, &w
);
1459 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1462 if( (w
< 0) || (w
> 0xffff) ){
1464 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1465 n
->name
, (int)(w
), (int)(w
));
1469 case NTAP_OPT_IRLEN
:
1470 pTap
->ir_length
= w
;
1471 reqbits
&= (~(NTREQ_IRLEN
));
1473 case NTAP_OPT_IRMASK
:
1474 pTap
->ir_capture_mask
= w
;
1475 reqbits
&= (~(NTREQ_IRMASK
));
1477 case NTAP_OPT_IRCAPTURE
:
1478 pTap
->ir_capture_value
= w
;
1479 reqbits
&= (~(NTREQ_IRCAPTURE
));
1482 } /* switch(n->value) */
1483 } /* while( goi->argc ) */
1485 /* Did all the required option bits get cleared? */
1488 jtag_tap_init(pTap
);
1492 Jim_SetResult_sprintf(goi
->interp
,
1493 "newtap: %s missing required parameters",
1495 jtag_tap_free(pTap
);
1499 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1505 struct command_context_s
*context
;
1509 JTAG_CMD_INIT_RESET
,
1512 JTAG_CMD_TAPDISABLE
,
1513 JTAG_CMD_TAPISENABLED
,
1518 const Jim_Nvp jtag_cmds
[] = {
1519 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1520 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1521 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1522 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1523 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1524 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1525 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1526 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1528 { .name
= NULL
, .value
= -1 },
1531 context
= Jim_GetAssocData(interp
, "context");
1532 /* go past the command */
1533 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1535 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1537 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1540 Jim_SetEmptyResult( goi
.interp
);
1542 case JTAG_CMD_INTERFACE
:
1543 /* return the name of the interface */
1544 /* TCL code might need to know the exact type... */
1545 /* FUTURE: we allow this as a means to "set" the interface. */
1546 if( goi
.argc
!= 0 ){
1547 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1550 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1552 case JTAG_CMD_INIT_RESET
:
1553 if( goi
.argc
!= 0 ){
1554 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1557 e
= jtag_init_reset(context
);
1558 if( e
!= ERROR_OK
){
1559 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1563 case JTAG_CMD_NEWTAP
:
1564 return jim_newtap_cmd( &goi
);
1566 case JTAG_CMD_TAPISENABLED
:
1567 case JTAG_CMD_TAPENABLE
:
1568 case JTAG_CMD_TAPDISABLE
:
1569 if( goi
.argc
!= 1 ){
1570 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1576 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1581 case JTAG_CMD_TAPISENABLED
:
1584 case JTAG_CMD_TAPENABLE
:
1585 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1589 case JTAG_CMD_TAPDISABLE
:
1590 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1595 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1602 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1609 Jim_GetOpt_Obj(&goi
, &o
);
1610 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1615 goi
.isconfigure
= 0;
1616 return jtag_tap_configure_cmd( &goi
, t
);
1620 case JTAG_CMD_CONFIGURE
:
1622 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1629 Jim_GetOpt_Obj(&goi
, &o
);
1630 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1635 goi
.isconfigure
= 1;
1636 return jtag_tap_configure_cmd( &goi
, t
);
1643 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1645 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1647 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1648 COMMAND_CONFIG
, "try to configure interface");
1649 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1650 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1651 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1652 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1653 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1654 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1655 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1656 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1658 "[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]");
1659 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1660 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1661 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1662 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1664 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1665 COMMAND_EXEC
, "print current scan chain configuration");
1667 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1668 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1669 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1670 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1671 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1672 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1673 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1674 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1676 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1677 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1678 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1679 COMMAND_ANY
, "verify value capture <enable|disable>");
1680 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1681 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1685 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1690 if (!jtag_interface
)
1692 /* nothing was previously specified by "interface" command */
1693 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1694 return ERROR_JTAG_INVALID_INTERFACE
;
1698 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1702 if (jtag_interface
->init() != ERROR_OK
)
1703 return ERROR_JTAG_INIT_FAILED
;
1705 jtag
= jtag_interface
;
1709 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1714 LOG_DEBUG("Init JTAG chain");
1716 tap
= jtag_tap_next_enabled(NULL
);
1718 LOG_ERROR("There are no enabled taps?");
1719 return ERROR_JTAG_INIT_FAILED
;
1723 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1726 /* examine chain first, as this could discover the real chain layout */
1727 if (jtag_examine_chain() != ERROR_OK
)
1729 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1732 if (jtag_validate_chain() != ERROR_OK
)
1734 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1740 int jtag_interface_quit(void)
1742 if (!jtag
|| !jtag
->quit
)
1745 // close the JTAG interface
1746 int result
= jtag
->quit();
1747 if (ERROR_OK
!= result
)
1748 LOG_ERROR("failed: %d", result
);
1754 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1758 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1761 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1763 /* Reset can happen after a power cycle.
1765 * Ideally we would only assert TRST or run RESET before the target reset.
1767 * However w/srst_pulls_trst, trst is asserted together with the target
1768 * reset whether we want it or not.
1770 * NB! Some targets have JTAG circuitry disabled until a
1771 * trst & srst has been asserted.
1773 * NB! here we assume nsrst/ntrst delay are sufficient!
1775 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1778 jtag_add_reset(1, 0); /* RESET or TRST */
1779 if (jtag_reset_config
& RESET_HAS_SRST
)
1781 jtag_add_reset(1, 1);
1782 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1783 jtag_add_reset(0, 1);
1785 jtag_add_reset(0, 0);
1786 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1789 /* Check that we can communication on the JTAG chain + eventually we want to
1790 * be able to perform enumeration only after OpenOCD has started
1791 * telnet and GDB server
1793 * That would allow users to more easily perform any magic they need to before
1796 return jtag_init_inner(cmd_ctx
);
1799 int jtag_init(struct command_context_s
*cmd_ctx
)
1802 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1804 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1808 return jtag_init_reset(cmd_ctx
);
1811 void jtag_set_speed_khz(unsigned khz
)
1815 unsigned jtag_get_speed_khz(void)
1820 static int default_khz(int khz
, int *jtag_speed
)
1822 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1826 static int default_speed_div(int speed
, int *khz
)
1828 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1832 static int default_power_dropout(int *dropout
)
1834 *dropout
=0; /* by default we can't detect power dropout */
1838 static int default_srst_asserted(int *srst_asserted
)
1840 *srst_asserted
=0; /* by default we can't detect srst asserted */
1844 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1849 /* check whether the interface is already configured */
1852 LOG_WARNING("Interface already configured, ignoring");
1856 /* interface name is a mandatory argument */
1857 if (argc
< 1 || args
[0][0] == '\0')
1859 return ERROR_COMMAND_SYNTAX_ERROR
;
1862 for (i
=0; jtag_interfaces
[i
]; i
++)
1864 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1866 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1871 jtag_interface
= jtag_interfaces
[i
];
1873 if (jtag_interface
->khz
== NULL
)
1875 jtag_interface
->khz
= default_khz
;
1877 if (jtag_interface
->speed_div
== NULL
)
1879 jtag_interface
->speed_div
= default_speed_div
;
1881 if (jtag_interface
->power_dropout
== NULL
)
1883 jtag_interface
->power_dropout
= default_power_dropout
;
1885 if (jtag_interface
->srst_asserted
== NULL
)
1887 jtag_interface
->srst_asserted
= default_srst_asserted
;
1894 /* no valid interface was found (i.e. the configuration option,
1895 * didn't match one of the compiled-in interfaces
1897 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1898 LOG_ERROR("compiled-in jtag interfaces:");
1899 for (i
= 0; jtag_interfaces
[i
]; i
++)
1901 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1904 return ERROR_JTAG_INVALID_INTERFACE
;
1907 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1911 Jim_Obj
*newargs
[ 10 ];
1914 * argv[-1] = command
1915 * argv[ 0] = ir length
1916 * argv[ 1] = ir capture
1917 * argv[ 2] = ir mask
1918 * argv[ 3] = not actually used by anything but in the docs
1922 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1925 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1926 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1930 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1931 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1932 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1933 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1935 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1936 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1937 sprintf( buf
, "chip%d", jtag_tap_count() );
1938 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1939 sprintf( buf
, "tap%d", jtag_tap_count() );
1940 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1941 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1942 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1943 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1944 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1945 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1946 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1948 command_print( cmd_ctx
, "NEW COMMAND:");
1949 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1950 Jim_GetString( newargs
[0], NULL
),
1951 Jim_GetString( newargs
[1], NULL
),
1952 Jim_GetString( newargs
[2], NULL
),
1953 Jim_GetString( newargs
[3], NULL
),
1954 Jim_GetString( newargs
[4], NULL
),
1955 Jim_GetString( newargs
[5], NULL
),
1956 Jim_GetString( newargs
[6], NULL
),
1957 Jim_GetString( newargs
[7], NULL
),
1958 Jim_GetString( newargs
[8], NULL
),
1959 Jim_GetString( newargs
[9], NULL
) );
1961 e
= jim_jtag_command( interp
, 10, newargs
);
1963 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1968 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1972 tap
= jtag_all_taps();
1973 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1974 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1977 u32 expected
, expected_mask
, cur_instr
, ii
;
1978 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1979 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1980 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1982 command_print(cmd_ctx
,
1983 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1984 tap
->abs_chain_position
,
1986 tap
->enabled
? 'Y' : 'n',
1988 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1994 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1995 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1996 tap
->expected_ids
[ii
]);
1999 tap
= tap
->next_tap
;
2005 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2011 return ERROR_COMMAND_SYNTAX_ERROR
;
2013 /* Original versions cared about the order of these tokens:
2014 * reset_config signals [combination [trst_type [srst_type]]]
2015 * They also clobbered the previous configuration even on error.
2017 * Here we don't care about the order, and only change values
2018 * which have been explicitly specified.
2020 for (; argc
; argc
--, args
++) {
2025 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2026 if (strcmp(*args
, "none") == 0)
2028 else if (strcmp(*args
, "trst_only") == 0)
2029 tmp
= RESET_HAS_TRST
;
2030 else if (strcmp(*args
, "srst_only") == 0)
2031 tmp
= RESET_HAS_SRST
;
2032 else if (strcmp(*args
, "trst_and_srst") == 0)
2033 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2037 LOG_ERROR("extra reset_config %s spec (%s)",
2039 return ERROR_INVALID_ARGUMENTS
;
2044 /* combination (options for broken wiring) */
2045 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2046 if (strcmp(*args
, "separate") == 0)
2047 /* separate reset lines - default */;
2048 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2049 tmp
|= RESET_SRST_PULLS_TRST
;
2050 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2051 tmp
|= RESET_TRST_PULLS_SRST
;
2052 else if (strcmp(*args
, "combined") == 0)
2053 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2057 LOG_ERROR("extra reset_config %s spec (%s)",
2058 "combination", *args
);
2059 return ERROR_INVALID_ARGUMENTS
;
2064 /* trst_type (NOP without HAS_TRST) */
2065 m
= RESET_TRST_OPEN_DRAIN
;
2066 if (strcmp(*args
, "trst_open_drain") == 0)
2067 tmp
|= RESET_TRST_OPEN_DRAIN
;
2068 else if (strcmp(*args
, "trst_push_pull") == 0)
2069 /* push/pull from adapter - default */;
2073 LOG_ERROR("extra reset_config %s spec (%s)",
2074 "trst_type", *args
);
2075 return ERROR_INVALID_ARGUMENTS
;
2080 /* srst_type (NOP without HAS_SRST) */
2081 m
|= RESET_SRST_PUSH_PULL
;
2082 if (strcmp(*args
, "srst_push_pull") == 0)
2083 tmp
|= RESET_SRST_PUSH_PULL
;
2084 else if (strcmp(*args
, "srst_open_drain") == 0)
2085 /* open drain from adapter - default */;
2089 LOG_ERROR("extra reset_config %s spec (%s)",
2090 "srst_type", *args
);
2091 return ERROR_INVALID_ARGUMENTS
;
2096 /* caller provided nonsense; fail */
2097 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2098 return ERROR_INVALID_ARGUMENTS
;
2101 /* Remember the bits which were specified (mask)
2102 * and their new values (new_cfg).
2108 /* clear previous values of those bits, save new values */
2109 jtag_reset_config
&= ~mask
;
2110 jtag_reset_config
|= new_cfg
;
2115 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2116 char *cmd
, char **args
, int argc
)
2120 LOG_ERROR("jtag_nsrst_delay <ms> -- command requires one argument");
2121 return ERROR_COMMAND_SYNTAX_ERROR
;
2123 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2127 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2128 char *cmd
, char **args
, int argc
)
2132 LOG_ERROR("jtag_ntrst_delay <ms> -- command requires one argument");
2133 return ERROR_COMMAND_SYNTAX_ERROR
;
2135 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2139 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2141 int retval
= ERROR_OK
;
2144 return ERROR_COMMAND_SYNTAX_ERROR
;
2147 LOG_DEBUG("handle jtag speed");
2150 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2152 /* this command can be called during CONFIG,
2153 * in which case jtag isn't initialized */
2155 retval
= jtag
->speed(cur_speed
);
2157 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2162 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2165 return ERROR_COMMAND_SYNTAX_ERROR
;
2167 int retval
= ERROR_OK
;
2171 LOG_DEBUG("handle jtag khz");
2173 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2176 LOG_DEBUG("have interface set up");
2178 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2179 if (ERROR_OK
!= retval
)
2181 jtag_set_speed_khz(0);
2184 cur_speed
= jtag_speed
= speed_div1
;
2186 retval
= jtag
->speed(cur_speed
);
2192 cur_speed
= jtag_get_speed_khz();
2195 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2196 if (ERROR_OK
!= retval
)
2201 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2203 command_print(cmd_ctx
, "RCLK - adaptive");
2208 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2215 return ERROR_COMMAND_SYNTAX_ERROR
;
2218 if (args
[0][0] == '1')
2220 else if (args
[0][0] == '0')
2224 return ERROR_COMMAND_SYNTAX_ERROR
;
2227 if (args
[1][0] == '1')
2229 else if (args
[1][0] == '0')
2233 return ERROR_COMMAND_SYNTAX_ERROR
;
2236 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2237 return ERROR_JTAG_INIT_FAILED
;
2239 jtag_add_reset(trst
, srst
);
2240 jtag_execute_queue();
2245 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2249 return ERROR_COMMAND_SYNTAX_ERROR
;
2252 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2253 jtag_execute_queue();
2260 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2261 * should be stable ... and *NOT* a shift state, otherwise free-running
2262 * jtag clocks could change the values latched by the update state.
2264 static bool scan_is_safe(tap_state_t state
)
2279 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2282 scan_field_t
*fields
;
2284 tap_state_t endstate
;
2286 if ((argc
< 2) || (argc
% 2))
2288 return ERROR_COMMAND_SYNTAX_ERROR
;
2291 /* optional "-endstate" "statename" at the end of the arguments,
2292 * so that e.g. IRPAUSE can let us load the data register before
2293 * entering RUN/IDLE to execute the instruction we load here.
2295 endstate
= TAP_IDLE
;
2298 /* have at least one pair of numbers. */
2299 /* is last pair the magic text? */
2300 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2303 cpA
= args
[ argc
-1 ];
2304 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2305 cpS
= tap_state_name( endstate
);
2306 if( 0 == strcmp( cpA
, cpS
) ){
2310 if( endstate
>= TAP_NUM_STATES
){
2311 return ERROR_COMMAND_SYNTAX_ERROR
;
2313 if (!scan_is_safe(endstate
))
2314 LOG_WARNING("irscan with unsafe "
2315 "endstate \"%s\"", cpA
);
2316 /* found - remove the last 2 args */
2322 int num_fields
= argc
/ 2;
2324 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2326 for (i
= 0; i
< num_fields
; i
++)
2328 tap
= jtag_tap_by_string( args
[i
*2] );
2331 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2334 int field_size
= tap
->ir_length
;
2335 fields
[i
].tap
= tap
;
2336 fields
[i
].num_bits
= field_size
;
2337 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2338 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2339 fields
[i
].in_value
= NULL
;
2342 /* did we have an endstate? */
2343 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2345 int retval
=jtag_execute_queue();
2347 for (i
= 0; i
< num_fields
; i
++)
2348 free(fields
[i
].out_value
);
2355 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2358 scan_field_t
*fields
;
2360 int field_count
= 0;
2363 tap_state_t endstate
;
2366 * args[2] = num_bits
2367 * args[3] = hex string
2368 * ... repeat num bits and hex string ...
2371 * args[N-2] = "-endstate"
2372 * args[N-1] = statename
2374 if ((argc
< 4) || ((argc
% 2)!=0))
2376 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2380 endstate
= TAP_IDLE
;
2382 /* validate arguments as numbers */
2384 for (i
= 2; i
< argc
; i
+=2)
2389 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2390 /* If valid - try next arg */
2395 /* Not valid.. are we at the end? */
2396 if ( ((i
+2) != argc
) ){
2397 /* nope, then error */
2401 /* it could be: "-endstate FOO"
2402 * e.g. DRPAUSE so we can issue more instructions
2403 * before entering RUN/IDLE and executing them.
2406 /* get arg as a string. */
2407 cp
= Jim_GetString( args
[i
], NULL
);
2408 /* is it the magic? */
2409 if( 0 == strcmp( "-endstate", cp
) ){
2410 /* is the statename valid? */
2411 cp
= Jim_GetString( args
[i
+1], NULL
);
2413 /* see if it is a valid state name */
2414 endstate
= tap_state_by_name(cp
);
2416 /* update the error message */
2417 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2419 if (!scan_is_safe(endstate
))
2420 LOG_WARNING("drscan with unsafe "
2421 "endstate \"%s\"", cp
);
2423 /* valid - so clear the error */
2425 /* and remove the last 2 args */
2430 /* Still an error? */
2432 return e
; /* too bad */
2434 } /* validate args */
2436 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2441 num_fields
=(argc
-2)/2;
2442 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2443 for (i
= 2; i
< argc
; i
+=2)
2449 Jim_GetLong(interp
, args
[i
], &bits
);
2450 str
= Jim_GetString(args
[i
+1], &len
);
2452 fields
[field_count
].tap
= tap
;
2453 fields
[field_count
].num_bits
= bits
;
2454 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2455 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2456 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2460 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2462 retval
= jtag_execute_queue();
2463 if (retval
!= ERROR_OK
)
2465 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2470 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2471 for (i
= 2; i
< argc
; i
+=2)
2476 Jim_GetLong(interp
, args
[i
], &bits
);
2477 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2478 free(fields
[field_count
].out_value
);
2480 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2485 Jim_SetResult(interp
, list
);
2493 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2495 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2501 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2505 if (strcmp(args
[0], "enable") == 0)
2507 jtag_verify_capture_ir
= 1;
2509 else if (strcmp(args
[0], "disable") == 0)
2511 jtag_verify_capture_ir
= 0;
2514 return ERROR_COMMAND_SYNTAX_ERROR
;
2516 } else if (argc
!= 0)
2518 return ERROR_COMMAND_SYNTAX_ERROR
;
2521 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2526 void jtag_set_verify(bool enable
)
2528 jtag_verify
= enable
;
2531 bool jtag_will_verify()
2536 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2539 return ERROR_COMMAND_SYNTAX_ERROR
;
2543 if (strcmp(args
[0], "enable") == 0)
2544 jtag_set_verify(true);
2545 else if (strcmp(args
[0], "disable") == 0)
2546 jtag_set_verify(false);
2548 return ERROR_COMMAND_SYNTAX_ERROR
;
2551 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2552 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2558 int jtag_power_dropout(int *dropout
)
2560 return jtag
->power_dropout(dropout
);
2563 int jtag_srst_asserted(int *srst_asserted
)
2565 return jtag
->srst_asserted(srst_asserted
);
2568 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2570 jtag_tap_event_action_t
* jteap
;
2573 jteap
= tap
->event_action
;
2577 if (jteap
->event
== e
) {
2579 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2582 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2583 Jim_GetString(jteap
->body
, NULL
) );
2584 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2585 Jim_PrintErrorMessage(interp
);
2589 jteap
= jteap
->next
;
2593 LOG_DEBUG( "event %d %s - no action",
2595 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2599 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2602 return ERROR_COMMAND_SYNTAX_ERROR
;
2607 if (strcmp(args
[0], "short") == 0)
2608 use_new_table
= true;
2609 else if (strcmp(args
[0], "long") == 0)
2610 use_new_table
= false;
2612 return ERROR_COMMAND_SYNTAX_ERROR
;
2614 tap_use_new_tms_table(use_new_table
);
2617 command_print(cmd_ctx
, "tms sequence is %s",
2618 tap_uses_new_tms_table() ? "short": "long");
2624 * Function jtag_add_statemove
2625 * moves from the current state to the goal \a state. This needs
2626 * to be handled according to the xsvf spec, see the XSTATE command
2629 int jtag_add_statemove(tap_state_t goal_state
)
2631 int retval
= ERROR_OK
;
2633 tap_state_t moves
[8];
2634 tap_state_t cur_state
= cmd_queue_cur_state
;
2639 LOG_DEBUG( "cur_state=%s goal_state=%s",
2640 tap_state_name(cur_state
),
2641 tap_state_name(goal_state
) );
2644 /* From the XSVF spec, pertaining to XSTATE:
2646 For special states known as stable states (Test-Logic-Reset,
2647 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2648 predefined TAP state paths when the starting state is a stable state and
2649 when the XSTATE specifies a new stable state (see the STATE command in
2650 the [Ref 5] for the TAP state paths between stable states). For
2651 non-stable states, XSTATE should specify a state that is only one TAP
2652 state transition distance from the current TAP state to avoid undefined
2653 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2654 transition the TAP through a specific state path.
2657 if (goal_state
==cur_state
)
2658 ; /* nothing to do */
2660 else if( goal_state
==TAP_RESET
)
2665 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2667 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2668 spec, then this code is not fully conformant to the xsvf spec. This
2669 puts a burden on tap_get_tms_path() function from the xsvf spec.
2670 If in doubt, you should confirm that that burden is being met.
2673 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2674 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2676 assert( (unsigned) tms_count
< DIM(moves
) );
2678 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2680 bool bit
= tms_bits
& 1;
2682 cur_state
= tap_state_transition(cur_state
, bit
);
2683 moves
[i
] = cur_state
;
2686 jtag_add_pathmove(tms_count
, moves
);
2689 /* else state must be immediately reachable in one clock cycle, and does not
2690 need to be a stable state.
2692 else if( tap_state_transition(cur_state
, true) == goal_state
2693 || tap_state_transition(cur_state
, false) == goal_state
)
2695 /* move a single state */
2696 moves
[0] = goal_state
;
2697 jtag_add_pathmove( 1, moves
);
2702 retval
= ERROR_FAIL
;
2708 void jtag_set_nsrst_delay(unsigned delay
)
2710 jtag_nsrst_delay
= delay
;
2712 unsigned jtag_get_nsrst_delay(void)
2714 return jtag_nsrst_delay
;
2716 void jtag_set_ntrst_delay(unsigned delay
)
2718 jtag_ntrst_delay
= delay
;
2720 unsigned jtag_get_ntrst_delay(void)
2722 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)