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 jtag_flush_queue_count
++;
907 jtag_set_error(interface_jtag_execute_queue());
910 int jtag_get_flush_queue_count(void)
912 return jtag_flush_queue_count
;
915 int jtag_execute_queue(void)
918 jtag_execute_queue_noclear();
924 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
926 jtag_tap_t
*tap
= priv
;
930 if (event
== JTAG_TRST_ASSERTED
)
932 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
939 void jtag_sleep(u32 us
)
941 alive_sleep(us
/1000);
944 /// maximum number of JTAG devices expected in the chain
945 #define JTAG_MAX_CHAIN_SIZE 20
947 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
948 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
949 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
951 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
953 scan_field_t field
= {
955 .num_bits
= num_idcode
* 32,
956 .out_value
= idcode_buffer
,
957 .in_value
= idcode_buffer
,
960 // initialize to the end of chain ID value
961 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
962 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
964 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
965 return jtag_execute_queue();
968 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
973 for (unsigned i
= 0; i
< count
* 4; i
++)
975 zero_check
|= idcodes
[i
];
976 one_check
&= idcodes
[i
];
979 /* if there wasn't a single non-zero bit or if all bits were one,
980 * the scan is not valid */
981 if (zero_check
== 0x00 || one_check
== 0xff)
983 LOG_ERROR("JTAG communication failure: check connection, "
984 "JTAG interface, target power etc.");
990 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
991 const char *name
, u32 idcode
)
993 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
994 "JTAG tap: %s %16.16s: 0x%08x "
995 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
997 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
1000 static bool jtag_idcode_is_final(u32 idcode
)
1002 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
1006 * This helper checks that remaining bits in the examined chain data are
1007 * all as expected, but a single JTAG device requires only 64 bits to be
1008 * read back correctly. This can help identify and diagnose problems
1009 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1011 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
1013 bool triggered
= false;
1014 for ( ; count
< max
- 31; count
+= 32)
1016 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
1017 // do not trigger the warning if the data looks good
1018 if (!triggered
&& jtag_idcode_is_final(idcode
))
1020 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1026 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1028 if (0 == tap
->expected_ids_cnt
)
1030 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1032 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1033 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1038 /* Loop over the expected identification codes and test for a match */
1040 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1042 if (tap
->idcode
== tap
->expected_ids
[ii
])
1046 /* If none of the expected ids matched, log an error */
1047 if (ii
!= tap
->expected_ids_cnt
)
1049 LOG_INFO("JTAG Tap/device matched");
1052 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1053 tap
->dotted_name
, tap
->idcode
);
1054 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1057 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1058 ii
+ 1, tap
->expected_ids_cnt
);
1059 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1060 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1065 /* Try to examine chain layout according to IEEE 1149.1 §12
1067 static int jtag_examine_chain(void)
1069 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1070 unsigned device_count
= 0;
1072 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1074 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1075 return ERROR_JTAG_INIT_FAILED
;
1077 /* point at the 1st tap */
1078 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1081 LOG_ERROR("JTAG: No taps enabled?");
1082 return ERROR_JTAG_INIT_FAILED
;
1085 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1087 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1088 if ((idcode
& 1) == 0)
1090 /* LSB must not be 0, this indicates a device in bypass */
1091 LOG_WARNING("Tap/Device does not have IDCODE");
1099 * End of chain (invalid manufacturer ID) some devices, such
1100 * as AVR will output all 1's instead of TDI input value at
1103 if (jtag_idcode_is_final(idcode
))
1105 jtag_examine_chain_end(idcode_buffer
,
1106 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1110 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1111 tap
? tap
->dotted_name
: "(not-named)",
1120 tap
->idcode
= idcode
;
1122 // ensure the TAP ID does matches what was expected
1123 if (!jtag_examine_chain_match_tap(tap
))
1124 return ERROR_JTAG_INIT_FAILED
;
1126 tap
= jtag_tap_next_enabled(tap
);
1129 /* see if number of discovered devices matches configuration */
1130 if (device_count
!= jtag_tap_count_enabled())
1132 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1133 "does not match (enabled) configuration (%i), total taps: %d",
1134 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1135 LOG_ERROR("check the config file and ensure proper JTAG communication"
1136 " (connections, speed, ...)");
1137 return ERROR_JTAG_INIT_FAILED
;
1143 static int jtag_validate_chain(void)
1146 int total_ir_length
= 0;
1152 total_ir_length
= 0;
1154 tap
= jtag_tap_next_enabled(tap
);
1158 total_ir_length
+= tap
->ir_length
;
1161 total_ir_length
+= 2;
1162 ir_test
= malloc(CEIL(total_ir_length
, 8));
1163 buf_set_ones(ir_test
, total_ir_length
);
1166 field
.num_bits
= total_ir_length
;
1167 field
.out_value
= ir_test
;
1168 field
.in_value
= ir_test
;
1171 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1172 jtag_execute_queue();
1178 tap
= jtag_tap_next_enabled(tap
);
1183 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1186 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1187 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
);
1190 return ERROR_JTAG_INIT_FAILED
;
1192 chain_pos
+= tap
->ir_length
;
1195 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1198 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1199 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
);
1202 return ERROR_JTAG_INIT_FAILED
;
1210 enum jtag_tap_cfg_param
{
1214 static Jim_Nvp nvp_config_opts
[] = {
1215 { .name
= "-event", .value
= JCFG_EVENT
},
1217 { .name
= NULL
, .value
= -1 }
1220 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1226 /* parse config or cget options */
1227 while (goi
->argc
> 0) {
1228 Jim_SetEmptyResult (goi
->interp
);
1230 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1232 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1238 if (goi
->argc
== 0) {
1239 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1243 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1245 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1249 if (goi
->isconfigure
) {
1250 if (goi
->argc
!= 1) {
1251 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1255 if (goi
->argc
!= 0) {
1256 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1262 jtag_tap_event_action_t
*jteap
;
1264 jteap
= tap
->event_action
;
1265 /* replace existing? */
1267 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1270 jteap
= jteap
->next
;
1273 if (goi
->isconfigure
) {
1274 if (jteap
== NULL
) {
1276 jteap
= calloc(1, sizeof (*jteap
));
1278 jteap
->event
= n
->value
;
1279 Jim_GetOpt_Obj( goi
, &o
);
1281 Jim_DecrRefCount(interp
, jteap
->body
);
1283 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1284 Jim_IncrRefCount(jteap
->body
);
1286 /* add to head of event list */
1287 jteap
->next
= tap
->event_action
;
1288 tap
->event_action
= jteap
;
1289 Jim_SetEmptyResult(goi
->interp
);
1292 if (jteap
== NULL
) {
1293 Jim_SetEmptyResult(goi
->interp
);
1295 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1302 } /* while (goi->argc) */
1308 static void jtag_tap_init(jtag_tap_t
*tap
)
1310 assert(0 != tap
->ir_length
);
1312 tap
->expected
= malloc(tap
->ir_length
);
1313 tap
->expected_mask
= malloc(tap
->ir_length
);
1314 tap
->cur_instr
= malloc(tap
->ir_length
);
1316 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1317 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1318 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1320 // place TAP in bypass mode
1322 // register the reset callback for the TAP
1323 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1325 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1326 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1327 tap
->abs_chain_position
, tap
->ir_length
,
1328 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1332 static void jtag_tap_free(jtag_tap_t
*tap
)
1334 /// @todo is anything missing? no memory leaks please
1335 free((void *)tap
->expected_ids
);
1336 free((void *)tap
->chip
);
1337 free((void *)tap
->tapname
);
1338 free((void *)tap
->dotted_name
);
1342 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1351 const Jim_Nvp opts
[] = {
1352 #define NTAP_OPT_IRLEN 0
1353 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1354 #define NTAP_OPT_IRMASK 1
1355 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1356 #define NTAP_OPT_IRCAPTURE 2
1357 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1358 #define NTAP_OPT_ENABLED 3
1359 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1360 #define NTAP_OPT_DISABLED 4
1361 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1362 #define NTAP_OPT_EXPECTED_ID 5
1363 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1364 { .name
= NULL
, .value
= -1 },
1367 pTap
= malloc( sizeof(jtag_tap_t
) );
1368 memset( pTap
, 0, sizeof(*pTap
) );
1370 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1374 * we expect CHIP + TAP + OPTIONS
1376 if( goi
->argc
< 3 ){
1377 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1380 Jim_GetOpt_String( goi
, &cp
, NULL
);
1381 pTap
->chip
= strdup(cp
);
1383 Jim_GetOpt_String( goi
, &cp
, NULL
);
1384 pTap
->tapname
= strdup(cp
);
1386 /* name + dot + name + null */
1387 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1389 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1390 pTap
->dotted_name
= cp
;
1392 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1393 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1395 /* default is enabled */
1398 /* deal with options */
1399 #define NTREQ_IRLEN 1
1400 #define NTREQ_IRCAPTURE 2
1401 #define NTREQ_IRMASK 4
1403 /* clear them as we find them */
1404 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1407 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1409 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1412 LOG_DEBUG("Processing option: %s", n
->name
);
1414 case NTAP_OPT_ENABLED
:
1417 case NTAP_OPT_DISABLED
:
1420 case NTAP_OPT_EXPECTED_ID
:
1422 u32
*new_expected_ids
;
1424 e
= Jim_GetOpt_Wide( goi
, &w
);
1426 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1430 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1431 if (new_expected_ids
== NULL
) {
1432 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1436 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1438 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1440 free(pTap
->expected_ids
);
1441 pTap
->expected_ids
= new_expected_ids
;
1442 pTap
->expected_ids_cnt
++;
1445 case NTAP_OPT_IRLEN
:
1446 case NTAP_OPT_IRMASK
:
1447 case NTAP_OPT_IRCAPTURE
:
1448 e
= Jim_GetOpt_Wide( goi
, &w
);
1450 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1453 if( (w
< 0) || (w
> 0xffff) ){
1455 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1456 n
->name
, (int)(w
), (int)(w
));
1460 case NTAP_OPT_IRLEN
:
1461 pTap
->ir_length
= w
;
1462 reqbits
&= (~(NTREQ_IRLEN
));
1464 case NTAP_OPT_IRMASK
:
1465 pTap
->ir_capture_mask
= w
;
1466 reqbits
&= (~(NTREQ_IRMASK
));
1468 case NTAP_OPT_IRCAPTURE
:
1469 pTap
->ir_capture_value
= w
;
1470 reqbits
&= (~(NTREQ_IRCAPTURE
));
1473 } /* switch(n->value) */
1474 } /* while( goi->argc ) */
1476 /* Did all the required option bits get cleared? */
1479 jtag_tap_init(pTap
);
1483 Jim_SetResult_sprintf(goi
->interp
,
1484 "newtap: %s missing required parameters",
1486 jtag_tap_free(pTap
);
1490 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1496 struct command_context_s
*context
;
1500 JTAG_CMD_INIT_RESET
,
1503 JTAG_CMD_TAPDISABLE
,
1504 JTAG_CMD_TAPISENABLED
,
1509 const Jim_Nvp jtag_cmds
[] = {
1510 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1511 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1512 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1513 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1514 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1515 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1516 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1517 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1519 { .name
= NULL
, .value
= -1 },
1522 context
= Jim_GetAssocData(interp
, "context");
1523 /* go past the command */
1524 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1526 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1528 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1531 Jim_SetEmptyResult( goi
.interp
);
1533 case JTAG_CMD_INTERFACE
:
1534 /* return the name of the interface */
1535 /* TCL code might need to know the exact type... */
1536 /* FUTURE: we allow this as a means to "set" the interface. */
1537 if( goi
.argc
!= 0 ){
1538 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1541 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1543 case JTAG_CMD_INIT_RESET
:
1544 if( goi
.argc
!= 0 ){
1545 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1548 e
= jtag_init_reset(context
);
1549 if( e
!= ERROR_OK
){
1550 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1554 case JTAG_CMD_NEWTAP
:
1555 return jim_newtap_cmd( &goi
);
1557 case JTAG_CMD_TAPISENABLED
:
1558 case JTAG_CMD_TAPENABLE
:
1559 case JTAG_CMD_TAPDISABLE
:
1560 if( goi
.argc
!= 1 ){
1561 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1567 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1572 case JTAG_CMD_TAPISENABLED
:
1575 case JTAG_CMD_TAPENABLE
:
1576 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1580 case JTAG_CMD_TAPDISABLE
:
1581 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1586 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1593 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1600 Jim_GetOpt_Obj(&goi
, &o
);
1601 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1606 goi
.isconfigure
= 0;
1607 return jtag_tap_configure_cmd( &goi
, t
);
1611 case JTAG_CMD_CONFIGURE
:
1613 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1620 Jim_GetOpt_Obj(&goi
, &o
);
1621 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1626 goi
.isconfigure
= 1;
1627 return jtag_tap_configure_cmd( &goi
, t
);
1634 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1636 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1638 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1639 COMMAND_CONFIG
, "try to configure interface");
1640 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1641 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1642 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1643 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1644 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1645 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1646 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1647 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1649 "[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]");
1650 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1651 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1652 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1653 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1655 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1656 COMMAND_EXEC
, "print current scan chain configuration");
1658 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1659 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1660 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1661 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1662 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1663 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1664 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1665 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1667 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1668 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1669 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1670 COMMAND_ANY
, "verify value capture <enable|disable>");
1671 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1672 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1676 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1681 if (!jtag_interface
)
1683 /* nothing was previously specified by "interface" command */
1684 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1685 return ERROR_JTAG_INVALID_INTERFACE
;
1689 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1693 if (jtag_interface
->init() != ERROR_OK
)
1694 return ERROR_JTAG_INIT_FAILED
;
1696 jtag
= jtag_interface
;
1700 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1705 LOG_DEBUG("Init JTAG chain");
1707 tap
= jtag_tap_next_enabled(NULL
);
1709 LOG_ERROR("There are no enabled taps?");
1710 return ERROR_JTAG_INIT_FAILED
;
1714 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1717 /* examine chain first, as this could discover the real chain layout */
1718 if (jtag_examine_chain() != ERROR_OK
)
1720 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1723 if (jtag_validate_chain() != ERROR_OK
)
1725 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1731 int jtag_interface_quit(void)
1733 if (!jtag
|| !jtag
->quit
)
1736 // close the JTAG interface
1737 int result
= jtag
->quit();
1738 if (ERROR_OK
!= result
)
1739 LOG_ERROR("failed: %d", result
);
1745 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1749 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1752 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1754 /* Reset can happen after a power cycle.
1756 * Ideally we would only assert TRST or run RESET before the target reset.
1758 * However w/srst_pulls_trst, trst is asserted together with the target
1759 * reset whether we want it or not.
1761 * NB! Some targets have JTAG circuitry disabled until a
1762 * trst & srst has been asserted.
1764 * NB! here we assume nsrst/ntrst delay are sufficient!
1766 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1769 jtag_add_reset(1, 0); /* RESET or TRST */
1770 if (jtag_reset_config
& RESET_HAS_SRST
)
1772 jtag_add_reset(1, 1);
1773 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1774 jtag_add_reset(0, 1);
1776 jtag_add_reset(0, 0);
1777 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1780 /* Check that we can communication on the JTAG chain + eventually we want to
1781 * be able to perform enumeration only after OpenOCD has started
1782 * telnet and GDB server
1784 * That would allow users to more easily perform any magic they need to before
1787 return jtag_init_inner(cmd_ctx
);
1790 int jtag_init(struct command_context_s
*cmd_ctx
)
1793 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1795 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1799 return jtag_init_reset(cmd_ctx
);
1802 void jtag_set_speed_khz(unsigned khz
)
1806 unsigned jtag_get_speed_khz(void)
1811 static int default_khz(int khz
, int *jtag_speed
)
1813 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1817 static int default_speed_div(int speed
, int *khz
)
1819 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1823 static int default_power_dropout(int *dropout
)
1825 *dropout
=0; /* by default we can't detect power dropout */
1829 static int default_srst_asserted(int *srst_asserted
)
1831 *srst_asserted
=0; /* by default we can't detect srst asserted */
1835 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1840 /* check whether the interface is already configured */
1843 LOG_WARNING("Interface already configured, ignoring");
1847 /* interface name is a mandatory argument */
1848 if (argc
< 1 || args
[0][0] == '\0')
1850 return ERROR_COMMAND_SYNTAX_ERROR
;
1853 for (i
=0; jtag_interfaces
[i
]; i
++)
1855 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1857 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1862 jtag_interface
= jtag_interfaces
[i
];
1864 if (jtag_interface
->khz
== NULL
)
1866 jtag_interface
->khz
= default_khz
;
1868 if (jtag_interface
->speed_div
== NULL
)
1870 jtag_interface
->speed_div
= default_speed_div
;
1872 if (jtag_interface
->power_dropout
== NULL
)
1874 jtag_interface
->power_dropout
= default_power_dropout
;
1876 if (jtag_interface
->srst_asserted
== NULL
)
1878 jtag_interface
->srst_asserted
= default_srst_asserted
;
1885 /* no valid interface was found (i.e. the configuration option,
1886 * didn't match one of the compiled-in interfaces
1888 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1889 LOG_ERROR("compiled-in jtag interfaces:");
1890 for (i
= 0; jtag_interfaces
[i
]; i
++)
1892 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1895 return ERROR_JTAG_INVALID_INTERFACE
;
1898 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1902 Jim_Obj
*newargs
[ 10 ];
1905 * argv[-1] = command
1906 * argv[ 0] = ir length
1907 * argv[ 1] = ir capture
1908 * argv[ 2] = ir mask
1909 * argv[ 3] = not actually used by anything but in the docs
1913 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1916 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1917 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1921 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1922 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1923 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1924 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1926 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1927 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1928 sprintf( buf
, "chip%d", jtag_tap_count() );
1929 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1930 sprintf( buf
, "tap%d", jtag_tap_count() );
1931 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1932 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1933 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1934 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1935 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1936 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1937 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1939 command_print( cmd_ctx
, "NEW COMMAND:");
1940 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1941 Jim_GetString( newargs
[0], NULL
),
1942 Jim_GetString( newargs
[1], NULL
),
1943 Jim_GetString( newargs
[2], NULL
),
1944 Jim_GetString( newargs
[3], NULL
),
1945 Jim_GetString( newargs
[4], NULL
),
1946 Jim_GetString( newargs
[5], NULL
),
1947 Jim_GetString( newargs
[6], NULL
),
1948 Jim_GetString( newargs
[7], NULL
),
1949 Jim_GetString( newargs
[8], NULL
),
1950 Jim_GetString( newargs
[9], NULL
) );
1952 e
= jim_jtag_command( interp
, 10, newargs
);
1954 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1959 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1963 tap
= jtag_all_taps();
1964 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1965 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1968 u32 expected
, expected_mask
, cur_instr
, ii
;
1969 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1970 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1971 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1973 command_print(cmd_ctx
,
1974 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1975 tap
->abs_chain_position
,
1977 tap
->enabled
? 'Y' : 'n',
1979 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1985 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1986 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1987 tap
->expected_ids
[ii
]);
1990 tap
= tap
->next_tap
;
1996 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2002 return ERROR_COMMAND_SYNTAX_ERROR
;
2004 /* Original versions cared about the order of these tokens:
2005 * reset_config signals [combination [trst_type [srst_type]]]
2006 * They also clobbered the previous configuration even on error.
2008 * Here we don't care about the order, and only change values
2009 * which have been explicitly specified.
2011 for (; argc
; argc
--, args
++) {
2016 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2017 if (strcmp(*args
, "none") == 0)
2019 else if (strcmp(*args
, "trst_only") == 0)
2020 tmp
= RESET_HAS_TRST
;
2021 else if (strcmp(*args
, "srst_only") == 0)
2022 tmp
= RESET_HAS_SRST
;
2023 else if (strcmp(*args
, "trst_and_srst") == 0)
2024 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2028 LOG_ERROR("extra reset_config %s spec (%s)",
2030 return ERROR_INVALID_ARGUMENTS
;
2035 /* combination (options for broken wiring) */
2036 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2037 if (strcmp(*args
, "separate") == 0)
2038 /* separate reset lines - default */;
2039 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2040 tmp
|= RESET_SRST_PULLS_TRST
;
2041 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2042 tmp
|= RESET_TRST_PULLS_SRST
;
2043 else if (strcmp(*args
, "combined") == 0)
2044 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2048 LOG_ERROR("extra reset_config %s spec (%s)",
2049 "combination", *args
);
2050 return ERROR_INVALID_ARGUMENTS
;
2055 /* trst_type (NOP without HAS_TRST) */
2056 m
= RESET_TRST_OPEN_DRAIN
;
2057 if (strcmp(*args
, "trst_open_drain") == 0)
2058 tmp
|= RESET_TRST_OPEN_DRAIN
;
2059 else if (strcmp(*args
, "trst_push_pull") == 0)
2060 /* push/pull from adapter - default */;
2064 LOG_ERROR("extra reset_config %s spec (%s)",
2065 "trst_type", *args
);
2066 return ERROR_INVALID_ARGUMENTS
;
2071 /* srst_type (NOP without HAS_SRST) */
2072 m
|= RESET_SRST_PUSH_PULL
;
2073 if (strcmp(*args
, "srst_push_pull") == 0)
2074 tmp
|= RESET_SRST_PUSH_PULL
;
2075 else if (strcmp(*args
, "srst_open_drain") == 0)
2076 /* open drain from adapter - default */;
2080 LOG_ERROR("extra reset_config %s spec (%s)",
2081 "srst_type", *args
);
2082 return ERROR_INVALID_ARGUMENTS
;
2087 /* caller provided nonsense; fail */
2088 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2089 return ERROR_INVALID_ARGUMENTS
;
2092 /* Remember the bits which were specified (mask)
2093 * and their new values (new_cfg).
2099 /* clear previous values of those bits, save new values */
2100 jtag_reset_config
&= ~mask
;
2101 jtag_reset_config
|= new_cfg
;
2106 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2107 char *cmd
, char **args
, int argc
)
2110 return ERROR_COMMAND_SYNTAX_ERROR
;
2112 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2113 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2117 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2118 char *cmd
, char **args
, int argc
)
2121 return ERROR_COMMAND_SYNTAX_ERROR
;
2123 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2124 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2128 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2130 int retval
= ERROR_OK
;
2133 return ERROR_COMMAND_SYNTAX_ERROR
;
2136 LOG_DEBUG("handle jtag speed");
2139 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2141 /* this command can be called during CONFIG,
2142 * in which case jtag isn't initialized */
2144 retval
= jtag
->speed(cur_speed
);
2146 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2151 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2154 return ERROR_COMMAND_SYNTAX_ERROR
;
2156 int retval
= ERROR_OK
;
2160 LOG_DEBUG("handle jtag khz");
2162 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2165 LOG_DEBUG("have interface set up");
2167 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2168 if (ERROR_OK
!= retval
)
2170 jtag_set_speed_khz(0);
2173 cur_speed
= jtag_speed
= speed_div1
;
2175 retval
= jtag
->speed(cur_speed
);
2181 cur_speed
= jtag_get_speed_khz();
2184 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2185 if (ERROR_OK
!= retval
)
2190 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2192 command_print(cmd_ctx
, "RCLK - adaptive");
2197 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
2198 char *cmd
, char **args
, int argc
)
2201 return ERROR_COMMAND_SYNTAX_ERROR
;
2204 if (args
[0][0] == '1')
2206 else if (args
[0][0] == '0')
2209 return ERROR_COMMAND_SYNTAX_ERROR
;
2212 if (args
[1][0] == '1')
2214 else if (args
[1][0] == '0')
2217 return ERROR_COMMAND_SYNTAX_ERROR
;
2219 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2220 return ERROR_JTAG_INIT_FAILED
;
2222 jtag_add_reset(trst
, srst
);
2223 jtag_execute_queue();
2228 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
2229 char *cmd
, char **args
, int argc
)
2232 return ERROR_COMMAND_SYNTAX_ERROR
;
2234 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2235 jtag_execute_queue();
2241 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2242 * should be stable ... and *NOT* a shift state, otherwise free-running
2243 * jtag clocks could change the values latched by the update state.
2245 static bool scan_is_safe(tap_state_t state
)
2260 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2263 scan_field_t
*fields
;
2265 tap_state_t endstate
;
2267 if ((argc
< 2) || (argc
% 2))
2269 return ERROR_COMMAND_SYNTAX_ERROR
;
2272 /* optional "-endstate" "statename" at the end of the arguments,
2273 * so that e.g. IRPAUSE can let us load the data register before
2274 * entering RUN/IDLE to execute the instruction we load here.
2276 endstate
= TAP_IDLE
;
2279 /* have at least one pair of numbers. */
2280 /* is last pair the magic text? */
2281 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2284 cpA
= args
[ argc
-1 ];
2285 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2286 cpS
= tap_state_name( endstate
);
2287 if( 0 == strcmp( cpA
, cpS
) ){
2291 if( endstate
>= TAP_NUM_STATES
){
2292 return ERROR_COMMAND_SYNTAX_ERROR
;
2294 if (!scan_is_safe(endstate
))
2295 LOG_WARNING("irscan with unsafe "
2296 "endstate \"%s\"", cpA
);
2297 /* found - remove the last 2 args */
2303 int num_fields
= argc
/ 2;
2305 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2307 for (i
= 0; i
< num_fields
; i
++)
2309 tap
= jtag_tap_by_string( args
[i
*2] );
2312 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2315 int field_size
= tap
->ir_length
;
2316 fields
[i
].tap
= tap
;
2317 fields
[i
].num_bits
= field_size
;
2318 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2319 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2320 fields
[i
].in_value
= NULL
;
2323 /* did we have an endstate? */
2324 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2326 int retval
=jtag_execute_queue();
2328 for (i
= 0; i
< num_fields
; i
++)
2329 free(fields
[i
].out_value
);
2336 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2339 scan_field_t
*fields
;
2341 int field_count
= 0;
2344 tap_state_t endstate
;
2347 * args[2] = num_bits
2348 * args[3] = hex string
2349 * ... repeat num bits and hex string ...
2352 * args[N-2] = "-endstate"
2353 * args[N-1] = statename
2355 if ((argc
< 4) || ((argc
% 2)!=0))
2357 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2361 endstate
= TAP_IDLE
;
2363 /* validate arguments as numbers */
2365 for (i
= 2; i
< argc
; i
+=2)
2370 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2371 /* If valid - try next arg */
2376 /* Not valid.. are we at the end? */
2377 if ( ((i
+2) != argc
) ){
2378 /* nope, then error */
2382 /* it could be: "-endstate FOO"
2383 * e.g. DRPAUSE so we can issue more instructions
2384 * before entering RUN/IDLE and executing them.
2387 /* get arg as a string. */
2388 cp
= Jim_GetString( args
[i
], NULL
);
2389 /* is it the magic? */
2390 if( 0 == strcmp( "-endstate", cp
) ){
2391 /* is the statename valid? */
2392 cp
= Jim_GetString( args
[i
+1], NULL
);
2394 /* see if it is a valid state name */
2395 endstate
= tap_state_by_name(cp
);
2397 /* update the error message */
2398 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2400 if (!scan_is_safe(endstate
))
2401 LOG_WARNING("drscan with unsafe "
2402 "endstate \"%s\"", cp
);
2404 /* valid - so clear the error */
2406 /* and remove the last 2 args */
2411 /* Still an error? */
2413 return e
; /* too bad */
2415 } /* validate args */
2417 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2422 num_fields
=(argc
-2)/2;
2423 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2424 for (i
= 2; i
< argc
; i
+=2)
2430 Jim_GetLong(interp
, args
[i
], &bits
);
2431 str
= Jim_GetString(args
[i
+1], &len
);
2433 fields
[field_count
].tap
= tap
;
2434 fields
[field_count
].num_bits
= bits
;
2435 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2436 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2437 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2441 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2443 retval
= jtag_execute_queue();
2444 if (retval
!= ERROR_OK
)
2446 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2451 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2452 for (i
= 2; i
< argc
; i
+=2)
2457 Jim_GetLong(interp
, args
[i
], &bits
);
2458 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2459 free(fields
[field_count
].out_value
);
2461 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2466 Jim_SetResult(interp
, list
);
2474 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2476 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2482 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2486 if (strcmp(args
[0], "enable") == 0)
2488 jtag_verify_capture_ir
= 1;
2490 else if (strcmp(args
[0], "disable") == 0)
2492 jtag_verify_capture_ir
= 0;
2495 return ERROR_COMMAND_SYNTAX_ERROR
;
2497 } else if (argc
!= 0)
2499 return ERROR_COMMAND_SYNTAX_ERROR
;
2502 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2507 void jtag_set_verify(bool enable
)
2509 jtag_verify
= enable
;
2512 bool jtag_will_verify()
2517 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2520 return ERROR_COMMAND_SYNTAX_ERROR
;
2524 if (strcmp(args
[0], "enable") == 0)
2525 jtag_set_verify(true);
2526 else if (strcmp(args
[0], "disable") == 0)
2527 jtag_set_verify(false);
2529 return ERROR_COMMAND_SYNTAX_ERROR
;
2532 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2533 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2539 int jtag_power_dropout(int *dropout
)
2541 return jtag
->power_dropout(dropout
);
2544 int jtag_srst_asserted(int *srst_asserted
)
2546 return jtag
->srst_asserted(srst_asserted
);
2549 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2551 jtag_tap_event_action_t
* jteap
;
2554 jteap
= tap
->event_action
;
2558 if (jteap
->event
== e
) {
2560 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2563 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2564 Jim_GetString(jteap
->body
, NULL
) );
2565 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2566 Jim_PrintErrorMessage(interp
);
2570 jteap
= jteap
->next
;
2574 LOG_DEBUG( "event %d %s - no action",
2576 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2580 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2583 return ERROR_COMMAND_SYNTAX_ERROR
;
2588 if (strcmp(args
[0], "short") == 0)
2589 use_new_table
= true;
2590 else if (strcmp(args
[0], "long") == 0)
2591 use_new_table
= false;
2593 return ERROR_COMMAND_SYNTAX_ERROR
;
2595 tap_use_new_tms_table(use_new_table
);
2598 command_print(cmd_ctx
, "tms sequence is %s",
2599 tap_uses_new_tms_table() ? "short": "long");
2605 * Function jtag_add_statemove
2606 * moves from the current state to the goal \a state. This needs
2607 * to be handled according to the xsvf spec, see the XSTATE command
2610 int jtag_add_statemove(tap_state_t goal_state
)
2612 int retval
= ERROR_OK
;
2614 tap_state_t moves
[8];
2615 tap_state_t cur_state
= cmd_queue_cur_state
;
2620 LOG_DEBUG( "cur_state=%s goal_state=%s",
2621 tap_state_name(cur_state
),
2622 tap_state_name(goal_state
) );
2625 /* From the XSVF spec, pertaining to XSTATE:
2627 For special states known as stable states (Test-Logic-Reset,
2628 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2629 predefined TAP state paths when the starting state is a stable state and
2630 when the XSTATE specifies a new stable state (see the STATE command in
2631 the [Ref 5] for the TAP state paths between stable states). For
2632 non-stable states, XSTATE should specify a state that is only one TAP
2633 state transition distance from the current TAP state to avoid undefined
2634 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2635 transition the TAP through a specific state path.
2638 if (goal_state
==cur_state
)
2639 ; /* nothing to do */
2641 else if( goal_state
==TAP_RESET
)
2646 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2648 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2649 spec, then this code is not fully conformant to the xsvf spec. This
2650 puts a burden on tap_get_tms_path() function from the xsvf spec.
2651 If in doubt, you should confirm that that burden is being met.
2654 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2655 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2657 assert( (unsigned) tms_count
< DIM(moves
) );
2659 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2661 bool bit
= tms_bits
& 1;
2663 cur_state
= tap_state_transition(cur_state
, bit
);
2664 moves
[i
] = cur_state
;
2667 jtag_add_pathmove(tms_count
, moves
);
2670 /* else state must be immediately reachable in one clock cycle, and does not
2671 need to be a stable state.
2673 else if( tap_state_transition(cur_state
, true) == goal_state
2674 || tap_state_transition(cur_state
, false) == goal_state
)
2676 /* move a single state */
2677 moves
[0] = goal_state
;
2678 jtag_add_pathmove( 1, moves
);
2683 retval
= ERROR_FAIL
;
2689 void jtag_set_nsrst_delay(unsigned delay
)
2691 jtag_nsrst_delay
= delay
;
2693 unsigned jtag_get_nsrst_delay(void)
2695 return jtag_nsrst_delay
;
2697 void jtag_set_ntrst_delay(unsigned delay
)
2699 jtag_ntrst_delay
= delay
;
2701 unsigned jtag_get_ntrst_delay(void)
2703 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)