1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
17 * This program is distributed in the hope that it will be useful, *
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
20 * GNU General Public License for more details. *
22 * You should have received a copy of the GNU General Public License *
23 * along with this program; if not, write to the *
24 * Free Software Foundation, Inc., *
25 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
26 ***************************************************************************/
32 #include "minidriver.h"
33 #include "interface.h"
40 /// The number of JTAG queue flushes (for profiling and debugging purposes).
41 static int jtag_flush_queue_count
;
43 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
44 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
);
46 /* note that this is not marked as static as it must be available from outside jtag.c for those
47 that implement the jtag_xxx() minidriver layer
49 int jtag_error
=ERROR_OK
;
51 char* jtag_event_strings
[] =
53 "JTAG controller reset (RESET or TRST)"
56 const Jim_Nvp nvp_jtag_tap_event
[] = {
57 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
58 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
60 { .name
= NULL
, .value
= -1 }
67 * List all TAPs that have been created.
69 static jtag_tap_t
*__jtag_all_taps
= NULL
;
71 * The number of TAPs in the __jtag_all_taps list, used to track the
72 * assigned chain position to new TAPs
74 static int jtag_num_taps
= 0;
76 enum reset_types jtag_reset_config
= RESET_NONE
;
77 tap_state_t cmd_queue_end_state
= TAP_RESET
;
78 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
80 int jtag_verify_capture_ir
= 1;
83 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
84 static int jtag_nsrst_delay
= 0; /* default to no nSRST delay */
85 static int jtag_ntrst_delay
= 0; /* default to no nTRST delay */
87 /* callbacks to inform high-level handlers about JTAG state changes */
88 jtag_event_callback_t
*jtag_event_callbacks
;
91 static int speed_khz
= 0;
92 /* flag if the kHz speed was defined */
93 static bool hasKHz
= false;
95 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
98 #if BUILD_ECOSBOARD == 1
99 extern jtag_interface_t zy1000_interface
;
100 #elif defined(BUILD_MINIDRIVER_DUMMY)
101 extern jtag_interface_t minidummy_interface
;
102 #else // standard drivers
103 #if BUILD_PARPORT == 1
104 extern jtag_interface_t parport_interface
;
108 extern jtag_interface_t dummy_interface
;
111 #if BUILD_FT2232_FTD2XX == 1
112 extern jtag_interface_t ft2232_interface
;
115 #if BUILD_FT2232_LIBFTDI == 1
116 extern jtag_interface_t ft2232_interface
;
119 #if BUILD_AMTJTAGACCEL == 1
120 extern jtag_interface_t amt_jtagaccel_interface
;
123 #if BUILD_EP93XX == 1
124 extern jtag_interface_t ep93xx_interface
;
127 #if BUILD_AT91RM9200 == 1
128 extern jtag_interface_t at91rm9200_interface
;
131 #if BUILD_GW16012 == 1
132 extern jtag_interface_t gw16012_interface
;
135 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
136 extern jtag_interface_t presto_interface
;
139 #if BUILD_USBPROG == 1
140 extern jtag_interface_t usbprog_interface
;
144 extern jtag_interface_t jlink_interface
;
147 #if BUILD_VSLLINK == 1
148 extern jtag_interface_t vsllink_interface
;
152 extern jtag_interface_t rlink_interface
;
155 #if BUILD_ARMJTAGEW == 1
156 extern jtag_interface_t armjtagew_interface
;
158 #endif // standard drivers
161 * The list of built-in JTAG interfaces, containing entries for those
162 * drivers that were enabled by the @c configure script.
164 * The list should be defined to contain either one minidriver interface
165 * or some number of standard driver interfaces, never both.
167 jtag_interface_t
*jtag_interfaces
[] = {
168 #if BUILD_ECOSBOARD == 1
170 #elif defined(BUILD_MINIDRIVER_DUMMY)
171 &minidummy_interface
,
172 #else // standard drivers
173 #if BUILD_PARPORT == 1
179 #if BUILD_FT2232_FTD2XX == 1
182 #if BUILD_FT2232_LIBFTDI == 1
185 #if BUILD_AMTJTAGACCEL == 1
186 &amt_jtagaccel_interface
,
188 #if BUILD_EP93XX == 1
191 #if BUILD_AT91RM9200 == 1
192 &at91rm9200_interface
,
194 #if BUILD_GW16012 == 1
197 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
200 #if BUILD_USBPROG == 1
206 #if BUILD_VSLLINK == 1
212 #if BUILD_ARMJTAGEW == 1
213 &armjtagew_interface
,
215 #endif // standard drivers
219 struct jtag_interface_s
*jtag
= NULL
;
222 static jtag_interface_t
*jtag_interface
= NULL
;
226 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
227 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
228 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
229 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
230 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
231 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
232 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
234 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
236 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
237 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
238 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
239 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
240 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
242 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
243 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
244 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
246 jtag_tap_t
*jtag_all_taps(void)
248 return __jtag_all_taps
;
251 int jtag_tap_count(void)
253 return jtag_num_taps
;
256 unsigned jtag_tap_count_enabled(void)
272 /// Append a new TAP to the chain of all taps.
273 static void jtag_tap_add(struct jtag_tap_s
*t
)
275 t
->abs_chain_position
= jtag_num_taps
++;
277 jtag_tap_t
**tap
= &__jtag_all_taps
;
279 tap
= &(*tap
)->next_tap
;
283 jtag_tap_t
*jtag_tap_by_string( const char *s
)
291 if( 0 == strcmp( t
->dotted_name
, s
) ){
297 /* backup plan is by number */
299 /* ok - is "s" a number? */
301 n
= strtol( s
, &cp
, 0 );
302 if( (s
!= cp
) && (*cp
== 0) ){
304 t
= jtag_tap_by_abs_position(n
);
310 jtag_tap_t
* jtag_tap_by_jim_obj( Jim_Interp
*interp
, Jim_Obj
*o
)
315 cp
= Jim_GetString( o
, NULL
);
320 t
= jtag_tap_by_string( cp
);
323 Jim_SetResult_sprintf(interp
,"Tap: %s is unknown", cp
);
328 /* returns a pointer to the n-th device in the scan chain */
329 jtag_tap_t
* jtag_tap_by_abs_position( int n
)
337 while( t
&& (n
> 0)) {
344 const char *jtag_tap_name(const jtag_tap_t
*tap
)
346 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
350 int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
)
352 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
354 if (callback
== NULL
)
356 return ERROR_INVALID_ARGUMENTS
;
361 while ((*callbacks_p
)->next
)
362 callbacks_p
= &((*callbacks_p
)->next
);
363 callbacks_p
= &((*callbacks_p
)->next
);
366 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
367 (*callbacks_p
)->callback
= callback
;
368 (*callbacks_p
)->priv
= priv
;
369 (*callbacks_p
)->next
= NULL
;
374 int jtag_unregister_event_callback(int (*callback
)(enum jtag_event event
, void *priv
))
376 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
378 if (callback
== NULL
)
380 return ERROR_INVALID_ARGUMENTS
;
385 jtag_event_callback_t
**next
= &((*callbacks_p
)->next
);
386 if ((*callbacks_p
)->callback
== callback
)
389 *callbacks_p
= *next
;
397 int jtag_call_event_callbacks(enum jtag_event event
)
399 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
401 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
405 callback
->callback(event
, callback
->priv
);
406 callback
= callback
->next
;
412 static void jtag_checks(void)
414 assert(jtag_trst
== 0);
417 static void jtag_prelude(tap_state_t state
)
421 assert(state
!=TAP_INVALID
);
423 cmd_queue_cur_state
= state
;
426 void jtag_alloc_in_value32(scan_field_t
*field
)
428 interface_jtag_alloc_in_value32(field
);
431 void jtag_add_ir_scan_noverify(int in_count
, const scan_field_t
*in_fields
,
436 int retval
= interface_jtag_add_ir_scan(in_count
, in_fields
, state
);
437 jtag_set_error(retval
);
442 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
444 * If the input field list contains an instruction value for a TAP then that is used
445 * otherwise the TAP is set to bypass.
447 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
450 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
452 if (jtag_verify
&&jtag_verify_capture_ir
)
454 /* 8 x 32 bit id's is enough for all invocations */
456 for (int j
= 0; j
< in_num_fields
; j
++)
458 /* if we are to run a verification of the ir scan, we need to get the input back.
459 * We may have to allocate space if the caller didn't ask for the input back.
461 in_fields
[j
].check_value
=in_fields
[j
].tap
->expected
;
462 in_fields
[j
].check_mask
=in_fields
[j
].tap
->expected_mask
;
464 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
467 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
472 * Duplicate the scan fields passed into the function into an IR SCAN command
474 * This function assumes that the caller handles extra fields for bypassed TAPs
477 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
,
482 int retval
= interface_jtag_add_plain_ir_scan(
483 in_num_fields
, in_fields
, state
);
484 jtag_set_error(retval
);
487 void jtag_add_callback(jtag_callback1_t f
, u8
*in
)
489 interface_jtag_add_callback(f
, in
);
492 void jtag_add_callback4(jtag_callback_t f
, u8
*in
,
493 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
494 jtag_callback_data_t data3
)
496 interface_jtag_add_callback4(f
, in
, data1
, data2
, data3
);
499 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
);
501 static int jtag_check_value_mask_callback(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
503 return jtag_check_value_inner(in
, (u8
*)data1
, (u8
*)data2
, (int)data3
);
506 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
507 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
509 for (int i
= 0; i
< in_num_fields
; i
++)
511 struct scan_field_s
*field
= &in_fields
[i
];
512 field
->allocated
= 0;
514 if (field
->check_value
|| field
->in_value
)
516 interface_jtag_add_scan_check_alloc(field
);
520 jtag_add_scan(in_num_fields
, in_fields
, state
);
522 for (int i
= 0; i
< in_num_fields
; i
++)
524 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
526 /* this is synchronous for a minidriver */
527 jtag_add_callback4(jtag_check_value_mask_callback
, in_fields
[i
].in_value
,
528 (jtag_callback_data_t
)in_fields
[i
].check_value
,
529 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
530 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
532 if (in_fields
[i
].allocated
)
534 free(in_fields
[i
].in_value
);
536 if (in_fields
[i
].modified
)
538 in_fields
[i
].in_value
= NULL
;
543 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
547 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
550 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
556 * Generate a DR SCAN using the fields passed to the function.
557 * For connected TAPs, the function checks in_fields and uses fields
558 * specified there. For bypassed TAPs, the function generates a dummy
559 * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan().
561 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
567 retval
= interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
568 jtag_set_error(retval
);
574 * Duplicate the scan fields passed into the function into a DR SCAN command
576 * This function assumes that the caller handles extra fields for bypassed TAPs
579 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
585 retval
=interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
586 if (retval
!=ERROR_OK
)
590 void jtag_add_dr_out(jtag_tap_t
* tap
,
591 int num_fields
, const int* num_bits
, const u32
* value
,
592 tap_state_t end_state
)
594 assert(end_state
!= TAP_INVALID
);
596 cmd_queue_cur_state
= end_state
;
598 interface_jtag_add_dr_out(tap
,
599 num_fields
, num_bits
, value
,
603 void jtag_add_tlr(void)
605 jtag_prelude(TAP_RESET
);
608 retval
=interface_jtag_add_tlr();
609 if (retval
!=ERROR_OK
)
612 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
615 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
617 tap_state_t cur_state
= cmd_queue_cur_state
;
621 /* the last state has to be a stable state */
622 if (!tap_is_state_stable(path
[num_states
- 1]))
624 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
628 for (i
=0; i
<num_states
; i
++)
630 if (path
[i
] == TAP_RESET
)
632 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
636 if ( tap_state_transition(cur_state
, true) != path
[i
]
637 && tap_state_transition(cur_state
, false) != path
[i
])
639 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[i
]));
647 retval
= interface_jtag_add_pathmove(num_states
, path
);
648 cmd_queue_cur_state
= path
[num_states
- 1];
649 if (retval
!=ERROR_OK
)
653 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
659 /* executed by sw or hw fifo */
660 retval
=interface_jtag_add_runtest(num_cycles
, state
);
661 if (retval
!=ERROR_OK
)
666 void jtag_add_clocks( int num_cycles
)
670 if( !tap_is_state_stable(cmd_queue_cur_state
) )
672 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
673 tap_state_name(cmd_queue_cur_state
) );
674 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
682 retval
= interface_jtag_add_clocks(num_cycles
);
683 if (retval
!= ERROR_OK
)
688 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
690 int trst_with_tlr
= 0;
693 /* FIX!!! there are *many* different cases here. A better
694 * approach is needed for legal combinations of transitions...
696 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
697 (jtag_reset_config
& RESET_HAS_TRST
)&&
698 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
700 if (((req_tlr_or_trst
&&!jtag_trst
)||
701 (!req_tlr_or_trst
&&jtag_trst
))&&
702 ((req_srst
&&!jtag_srst
)||
703 (!req_srst
&&jtag_srst
)))
705 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
706 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
710 /* Make sure that jtag_reset_config allows the requested reset */
711 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
712 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
714 LOG_ERROR("BUG: requested reset would assert trst");
715 jtag_error
=ERROR_FAIL
;
719 /* if TRST pulls SRST, we reset with TAP T-L-R */
720 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
725 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
727 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
728 jtag_error
=ERROR_FAIL
;
734 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
746 jtag_srst
= req_srst
;
748 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
749 if (retval
!=ERROR_OK
)
754 jtag_execute_queue();
758 LOG_DEBUG("SRST line asserted");
762 LOG_DEBUG("SRST line released");
763 if (jtag_nsrst_delay
)
764 jtag_add_sleep(jtag_nsrst_delay
* 1000);
769 LOG_DEBUG("JTAG reset with RESET instead of TRST");
770 jtag_set_end_state(TAP_RESET
);
777 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
778 * and inform possible listeners about this
780 LOG_DEBUG("TRST line asserted");
781 tap_set_state(TAP_RESET
);
782 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
786 if (jtag_ntrst_delay
)
787 jtag_add_sleep(jtag_ntrst_delay
* 1000);
791 tap_state_t
jtag_set_end_state(tap_state_t state
)
793 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
795 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
798 if (state
!=TAP_INVALID
)
799 cmd_queue_end_state
= state
;
800 return cmd_queue_end_state
;
803 tap_state_t
jtag_get_end_state(void)
805 return cmd_queue_end_state
;
808 void jtag_add_sleep(u32 us
)
810 keep_alive(); /* we might be running on a very slow JTAG clk */
811 int retval
=interface_jtag_add_sleep(us
);
812 if (retval
!=ERROR_OK
)
817 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
819 int retval
= ERROR_OK
;
821 int compare_failed
= 0;
824 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
826 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
829 /* An error handler could have caught the failing check
830 * only report a problem when there wasn't a handler, or if the handler
831 * acknowledged the error
834 LOG_WARNING("TAP %s:",
835 jtag_tap_name(field->tap));
839 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
840 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
844 char *in_check_mask_char
;
845 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
846 LOG_WARNING("value captured during scan didn't pass the requested check:");
847 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
848 captured_char
, in_check_value_char
, in_check_mask_char
);
849 free(in_check_mask_char
);
853 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
);
857 free(in_check_value_char
);
859 retval
= ERROR_JTAG_QUEUE_FAILED
;
866 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
868 assert(field
->in_value
!= NULL
);
872 /* no checking to do */
876 jtag_execute_queue_noclear();
878 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
879 jtag_set_error(retval
);
884 int default_interface_jtag_execute_queue(void)
888 LOG_ERROR("No JTAG interface configured yet. "
889 "Issue 'init' command in startup scripts "
890 "before communicating with targets.");
894 return jtag
->execute_queue();
897 void jtag_execute_queue_noclear(void)
899 jtag_flush_queue_count
++;
900 jtag_set_error(interface_jtag_execute_queue());
903 int jtag_get_flush_queue_count(void)
905 return jtag_flush_queue_count
;
908 int jtag_execute_queue(void)
910 jtag_execute_queue_noclear();
911 return jtag_error_clear();
914 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
916 jtag_tap_t
*tap
= priv
;
920 if (event
== JTAG_TRST_ASSERTED
)
922 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
929 void jtag_sleep(u32 us
)
931 alive_sleep(us
/1000);
934 /// maximum number of JTAG devices expected in the chain
935 #define JTAG_MAX_CHAIN_SIZE 20
937 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
938 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
939 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
941 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
943 scan_field_t field
= {
945 .num_bits
= num_idcode
* 32,
946 .out_value
= idcode_buffer
,
947 .in_value
= idcode_buffer
,
950 // initialize to the end of chain ID value
951 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
952 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
954 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
955 return jtag_execute_queue();
958 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
963 for (unsigned i
= 0; i
< count
* 4; i
++)
965 zero_check
|= idcodes
[i
];
966 one_check
&= idcodes
[i
];
969 /* if there wasn't a single non-zero bit or if all bits were one,
970 * the scan is not valid */
971 if (zero_check
== 0x00 || one_check
== 0xff)
973 LOG_ERROR("JTAG communication failure: check connection, "
974 "JTAG interface, target power etc.");
980 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
981 const char *name
, u32 idcode
)
983 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
984 "JTAG tap: %s %16.16s: 0x%08x "
985 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
987 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
990 static bool jtag_idcode_is_final(u32 idcode
)
992 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
996 * This helper checks that remaining bits in the examined chain data are
997 * all as expected, but a single JTAG device requires only 64 bits to be
998 * read back correctly. This can help identify and diagnose problems
999 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1001 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
1003 bool triggered
= false;
1004 for ( ; count
< max
- 31; count
+= 32)
1006 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
1007 // do not trigger the warning if the data looks good
1008 if (!triggered
&& jtag_idcode_is_final(idcode
))
1010 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1016 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1018 if (0 == tap
->expected_ids_cnt
)
1020 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1022 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1023 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1028 /* Loop over the expected identification codes and test for a match */
1030 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1032 if (tap
->idcode
== tap
->expected_ids
[ii
])
1036 /* If none of the expected ids matched, log an error */
1037 if (ii
!= tap
->expected_ids_cnt
)
1039 LOG_INFO("JTAG Tap/device matched");
1042 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1043 tap
->dotted_name
, tap
->idcode
);
1044 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1047 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1048 ii
+ 1, tap
->expected_ids_cnt
);
1049 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1050 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1055 /* Try to examine chain layout according to IEEE 1149.1 §12
1057 static int jtag_examine_chain(void)
1059 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1060 unsigned device_count
= 0;
1062 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1064 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1065 return ERROR_JTAG_INIT_FAILED
;
1067 /* point at the 1st tap */
1068 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1071 LOG_ERROR("JTAG: No taps enabled?");
1072 return ERROR_JTAG_INIT_FAILED
;
1075 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1077 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1078 if ((idcode
& 1) == 0)
1080 /* LSB must not be 0, this indicates a device in bypass */
1081 LOG_WARNING("Tap/Device does not have IDCODE");
1089 * End of chain (invalid manufacturer ID) some devices, such
1090 * as AVR will output all 1's instead of TDI input value at
1093 if (jtag_idcode_is_final(idcode
))
1095 jtag_examine_chain_end(idcode_buffer
,
1096 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1100 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1101 tap
? tap
->dotted_name
: "(not-named)",
1110 tap
->idcode
= idcode
;
1112 // ensure the TAP ID does matches what was expected
1113 if (!jtag_examine_chain_match_tap(tap
))
1114 return ERROR_JTAG_INIT_FAILED
;
1116 tap
= jtag_tap_next_enabled(tap
);
1119 /* see if number of discovered devices matches configuration */
1120 if (device_count
!= jtag_tap_count_enabled())
1122 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1123 "does not match (enabled) configuration (%i), total taps: %d",
1124 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1125 LOG_ERROR("check the config file and ensure proper JTAG communication"
1126 " (connections, speed, ...)");
1127 return ERROR_JTAG_INIT_FAILED
;
1133 static int jtag_validate_chain(void)
1136 int total_ir_length
= 0;
1142 total_ir_length
= 0;
1144 tap
= jtag_tap_next_enabled(tap
);
1148 total_ir_length
+= tap
->ir_length
;
1151 total_ir_length
+= 2;
1152 ir_test
= malloc(CEIL(total_ir_length
, 8));
1153 buf_set_ones(ir_test
, total_ir_length
);
1156 field
.num_bits
= total_ir_length
;
1157 field
.out_value
= ir_test
;
1158 field
.in_value
= ir_test
;
1161 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1162 jtag_execute_queue();
1168 tap
= jtag_tap_next_enabled(tap
);
1173 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1176 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1177 LOG_ERROR("Could not validate 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
);
1180 return ERROR_JTAG_INIT_FAILED
;
1182 chain_pos
+= tap
->ir_length
;
1185 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1188 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1189 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
);
1192 return ERROR_JTAG_INIT_FAILED
;
1200 enum jtag_tap_cfg_param
{
1204 static Jim_Nvp nvp_config_opts
[] = {
1205 { .name
= "-event", .value
= JCFG_EVENT
},
1207 { .name
= NULL
, .value
= -1 }
1210 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1216 /* parse config or cget options */
1217 while (goi
->argc
> 0) {
1218 Jim_SetEmptyResult (goi
->interp
);
1220 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1222 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1228 if (goi
->argc
== 0) {
1229 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1233 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1235 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1239 if (goi
->isconfigure
) {
1240 if (goi
->argc
!= 1) {
1241 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1245 if (goi
->argc
!= 0) {
1246 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1252 jtag_tap_event_action_t
*jteap
;
1254 jteap
= tap
->event_action
;
1255 /* replace existing? */
1257 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1260 jteap
= jteap
->next
;
1263 if (goi
->isconfigure
) {
1264 if (jteap
== NULL
) {
1266 jteap
= calloc(1, sizeof (*jteap
));
1268 jteap
->event
= n
->value
;
1269 Jim_GetOpt_Obj( goi
, &o
);
1271 Jim_DecrRefCount(interp
, jteap
->body
);
1273 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1274 Jim_IncrRefCount(jteap
->body
);
1276 /* add to head of event list */
1277 jteap
->next
= tap
->event_action
;
1278 tap
->event_action
= jteap
;
1279 Jim_SetEmptyResult(goi
->interp
);
1282 if (jteap
== NULL
) {
1283 Jim_SetEmptyResult(goi
->interp
);
1285 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1292 } /* while (goi->argc) */
1298 static void jtag_tap_init(jtag_tap_t
*tap
)
1300 assert(0 != tap
->ir_length
);
1302 tap
->expected
= malloc(tap
->ir_length
);
1303 tap
->expected_mask
= malloc(tap
->ir_length
);
1304 tap
->cur_instr
= malloc(tap
->ir_length
);
1306 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1307 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1308 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1310 // place TAP in bypass mode
1312 // register the reset callback for the TAP
1313 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1315 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1316 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1317 tap
->abs_chain_position
, tap
->ir_length
,
1318 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1322 static void jtag_tap_free(jtag_tap_t
*tap
)
1324 /// @todo is anything missing? no memory leaks please
1325 free((void *)tap
->expected_ids
);
1326 free((void *)tap
->chip
);
1327 free((void *)tap
->tapname
);
1328 free((void *)tap
->dotted_name
);
1332 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1341 const Jim_Nvp opts
[] = {
1342 #define NTAP_OPT_IRLEN 0
1343 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1344 #define NTAP_OPT_IRMASK 1
1345 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1346 #define NTAP_OPT_IRCAPTURE 2
1347 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1348 #define NTAP_OPT_ENABLED 3
1349 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1350 #define NTAP_OPT_DISABLED 4
1351 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1352 #define NTAP_OPT_EXPECTED_ID 5
1353 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1354 { .name
= NULL
, .value
= -1 },
1357 pTap
= malloc( sizeof(jtag_tap_t
) );
1358 memset( pTap
, 0, sizeof(*pTap
) );
1360 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1364 * we expect CHIP + TAP + OPTIONS
1366 if( goi
->argc
< 3 ){
1367 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1370 Jim_GetOpt_String( goi
, &cp
, NULL
);
1371 pTap
->chip
= strdup(cp
);
1373 Jim_GetOpt_String( goi
, &cp
, NULL
);
1374 pTap
->tapname
= strdup(cp
);
1376 /* name + dot + name + null */
1377 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1379 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1380 pTap
->dotted_name
= cp
;
1382 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1383 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1385 /* default is enabled */
1388 /* deal with options */
1389 #define NTREQ_IRLEN 1
1390 #define NTREQ_IRCAPTURE 2
1391 #define NTREQ_IRMASK 4
1393 /* clear them as we find them */
1394 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1397 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1399 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1402 LOG_DEBUG("Processing option: %s", n
->name
);
1404 case NTAP_OPT_ENABLED
:
1407 case NTAP_OPT_DISABLED
:
1410 case NTAP_OPT_EXPECTED_ID
:
1412 u32
*new_expected_ids
;
1414 e
= Jim_GetOpt_Wide( goi
, &w
);
1416 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1420 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1421 if (new_expected_ids
== NULL
) {
1422 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1426 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1428 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1430 free(pTap
->expected_ids
);
1431 pTap
->expected_ids
= new_expected_ids
;
1432 pTap
->expected_ids_cnt
++;
1435 case NTAP_OPT_IRLEN
:
1436 case NTAP_OPT_IRMASK
:
1437 case NTAP_OPT_IRCAPTURE
:
1438 e
= Jim_GetOpt_Wide( goi
, &w
);
1440 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1443 if( (w
< 0) || (w
> 0xffff) ){
1445 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1446 n
->name
, (int)(w
), (int)(w
));
1450 case NTAP_OPT_IRLEN
:
1451 pTap
->ir_length
= w
;
1452 reqbits
&= (~(NTREQ_IRLEN
));
1454 case NTAP_OPT_IRMASK
:
1455 pTap
->ir_capture_mask
= w
;
1456 reqbits
&= (~(NTREQ_IRMASK
));
1458 case NTAP_OPT_IRCAPTURE
:
1459 pTap
->ir_capture_value
= w
;
1460 reqbits
&= (~(NTREQ_IRCAPTURE
));
1463 } /* switch(n->value) */
1464 } /* while( goi->argc ) */
1466 /* Did all the required option bits get cleared? */
1469 jtag_tap_init(pTap
);
1473 Jim_SetResult_sprintf(goi
->interp
,
1474 "newtap: %s missing required parameters",
1476 jtag_tap_free(pTap
);
1480 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1486 struct command_context_s
*context
;
1490 JTAG_CMD_INIT_RESET
,
1493 JTAG_CMD_TAPDISABLE
,
1494 JTAG_CMD_TAPISENABLED
,
1499 const Jim_Nvp jtag_cmds
[] = {
1500 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1501 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1502 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1503 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1504 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1505 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1506 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1507 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1509 { .name
= NULL
, .value
= -1 },
1512 context
= Jim_GetAssocData(interp
, "context");
1513 /* go past the command */
1514 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1516 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1518 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1521 Jim_SetEmptyResult( goi
.interp
);
1523 case JTAG_CMD_INTERFACE
:
1524 /* return the name of the interface */
1525 /* TCL code might need to know the exact type... */
1526 /* FUTURE: we allow this as a means to "set" the interface. */
1527 if( goi
.argc
!= 0 ){
1528 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1531 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1533 case JTAG_CMD_INIT_RESET
:
1534 if( goi
.argc
!= 0 ){
1535 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1538 e
= jtag_init_reset(context
);
1539 if( e
!= ERROR_OK
){
1540 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1544 case JTAG_CMD_NEWTAP
:
1545 return jim_newtap_cmd( &goi
);
1547 case JTAG_CMD_TAPISENABLED
:
1548 case JTAG_CMD_TAPENABLE
:
1549 case JTAG_CMD_TAPDISABLE
:
1550 if( goi
.argc
!= 1 ){
1551 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1557 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1562 case JTAG_CMD_TAPISENABLED
:
1565 case JTAG_CMD_TAPENABLE
:
1566 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1570 case JTAG_CMD_TAPDISABLE
:
1571 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1576 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1583 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1590 Jim_GetOpt_Obj(&goi
, &o
);
1591 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1596 goi
.isconfigure
= 0;
1597 return jtag_tap_configure_cmd( &goi
, t
);
1601 case JTAG_CMD_CONFIGURE
:
1603 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1610 Jim_GetOpt_Obj(&goi
, &o
);
1611 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1616 goi
.isconfigure
= 1;
1617 return jtag_tap_configure_cmd( &goi
, t
);
1624 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1626 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1628 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1629 COMMAND_CONFIG
, "try to configure interface");
1630 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1631 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1632 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1633 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1634 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1635 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1636 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1637 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1639 "[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]");
1640 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1641 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1642 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1643 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1645 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1646 COMMAND_EXEC
, "print current scan chain configuration");
1648 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1649 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1650 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1651 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1652 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1653 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1654 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1655 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1657 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1658 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1659 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1660 COMMAND_ANY
, "verify value capture <enable|disable>");
1661 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1662 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1666 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1671 if (!jtag_interface
)
1673 /* nothing was previously specified by "interface" command */
1674 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1675 return ERROR_JTAG_INVALID_INTERFACE
;
1679 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1683 if (jtag_interface
->init() != ERROR_OK
)
1684 return ERROR_JTAG_INIT_FAILED
;
1686 jtag
= jtag_interface
;
1690 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1695 LOG_DEBUG("Init JTAG chain");
1697 tap
= jtag_tap_next_enabled(NULL
);
1699 LOG_ERROR("There are no enabled taps?");
1700 return ERROR_JTAG_INIT_FAILED
;
1704 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1707 /* examine chain first, as this could discover the real chain layout */
1708 if (jtag_examine_chain() != ERROR_OK
)
1710 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1713 if (jtag_validate_chain() != ERROR_OK
)
1715 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1721 int jtag_interface_quit(void)
1723 if (!jtag
|| !jtag
->quit
)
1726 // close the JTAG interface
1727 int result
= jtag
->quit();
1728 if (ERROR_OK
!= result
)
1729 LOG_ERROR("failed: %d", result
);
1735 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1739 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1742 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1744 /* Reset can happen after a power cycle.
1746 * Ideally we would only assert TRST or run RESET before the target reset.
1748 * However w/srst_pulls_trst, trst is asserted together with the target
1749 * reset whether we want it or not.
1751 * NB! Some targets have JTAG circuitry disabled until a
1752 * trst & srst has been asserted.
1754 * NB! here we assume nsrst/ntrst delay are sufficient!
1756 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1759 jtag_add_reset(1, 0); /* RESET or TRST */
1760 if (jtag_reset_config
& RESET_HAS_SRST
)
1762 jtag_add_reset(1, 1);
1763 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1764 jtag_add_reset(0, 1);
1766 jtag_add_reset(0, 0);
1767 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1770 /* Check that we can communication on the JTAG chain + eventually we want to
1771 * be able to perform enumeration only after OpenOCD has started
1772 * telnet and GDB server
1774 * That would allow users to more easily perform any magic they need to before
1777 return jtag_init_inner(cmd_ctx
);
1780 int jtag_init(struct command_context_s
*cmd_ctx
)
1783 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1785 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1789 return jtag_init_reset(cmd_ctx
);
1792 void jtag_set_speed_khz(unsigned khz
)
1796 unsigned jtag_get_speed_khz(void)
1801 static int default_khz(int khz
, int *jtag_speed
)
1803 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1807 static int default_speed_div(int speed
, int *khz
)
1809 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1813 static int default_power_dropout(int *dropout
)
1815 *dropout
=0; /* by default we can't detect power dropout */
1819 static int default_srst_asserted(int *srst_asserted
)
1821 *srst_asserted
=0; /* by default we can't detect srst asserted */
1825 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1830 /* check whether the interface is already configured */
1833 LOG_WARNING("Interface already configured, ignoring");
1837 /* interface name is a mandatory argument */
1838 if (argc
< 1 || args
[0][0] == '\0')
1840 return ERROR_COMMAND_SYNTAX_ERROR
;
1843 for (i
=0; jtag_interfaces
[i
]; i
++)
1845 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1847 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1852 jtag_interface
= jtag_interfaces
[i
];
1854 if (jtag_interface
->khz
== NULL
)
1856 jtag_interface
->khz
= default_khz
;
1858 if (jtag_interface
->speed_div
== NULL
)
1860 jtag_interface
->speed_div
= default_speed_div
;
1862 if (jtag_interface
->power_dropout
== NULL
)
1864 jtag_interface
->power_dropout
= default_power_dropout
;
1866 if (jtag_interface
->srst_asserted
== NULL
)
1868 jtag_interface
->srst_asserted
= default_srst_asserted
;
1875 /* no valid interface was found (i.e. the configuration option,
1876 * didn't match one of the compiled-in interfaces
1878 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1879 LOG_ERROR("compiled-in jtag interfaces:");
1880 for (i
= 0; jtag_interfaces
[i
]; i
++)
1882 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1885 return ERROR_JTAG_INVALID_INTERFACE
;
1888 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1892 Jim_Obj
*newargs
[ 10 ];
1895 * argv[-1] = command
1896 * argv[ 0] = ir length
1897 * argv[ 1] = ir capture
1898 * argv[ 2] = ir mask
1899 * argv[ 3] = not actually used by anything but in the docs
1903 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1906 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1907 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1911 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1912 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1913 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1914 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1916 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1917 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1918 sprintf( buf
, "chip%d", jtag_tap_count() );
1919 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1920 sprintf( buf
, "tap%d", jtag_tap_count() );
1921 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1922 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1923 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1924 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1925 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1926 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1927 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1929 command_print( cmd_ctx
, "NEW COMMAND:");
1930 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1931 Jim_GetString( newargs
[0], NULL
),
1932 Jim_GetString( newargs
[1], NULL
),
1933 Jim_GetString( newargs
[2], NULL
),
1934 Jim_GetString( newargs
[3], NULL
),
1935 Jim_GetString( newargs
[4], NULL
),
1936 Jim_GetString( newargs
[5], NULL
),
1937 Jim_GetString( newargs
[6], NULL
),
1938 Jim_GetString( newargs
[7], NULL
),
1939 Jim_GetString( newargs
[8], NULL
),
1940 Jim_GetString( newargs
[9], NULL
) );
1942 e
= jim_jtag_command( interp
, 10, newargs
);
1944 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1949 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1953 tap
= jtag_all_taps();
1954 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1955 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1958 u32 expected
, expected_mask
, cur_instr
, ii
;
1959 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1960 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1961 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1963 command_print(cmd_ctx
,
1964 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1965 tap
->abs_chain_position
,
1967 tap
->enabled
? 'Y' : 'n',
1969 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1975 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1976 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1977 tap
->expected_ids
[ii
]);
1980 tap
= tap
->next_tap
;
1986 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1992 return ERROR_COMMAND_SYNTAX_ERROR
;
1994 /* Original versions cared about the order of these tokens:
1995 * reset_config signals [combination [trst_type [srst_type]]]
1996 * They also clobbered the previous configuration even on error.
1998 * Here we don't care about the order, and only change values
1999 * which have been explicitly specified.
2001 for (; argc
; argc
--, args
++) {
2006 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2007 if (strcmp(*args
, "none") == 0)
2009 else if (strcmp(*args
, "trst_only") == 0)
2010 tmp
= RESET_HAS_TRST
;
2011 else if (strcmp(*args
, "srst_only") == 0)
2012 tmp
= RESET_HAS_SRST
;
2013 else if (strcmp(*args
, "trst_and_srst") == 0)
2014 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2018 LOG_ERROR("extra reset_config %s spec (%s)",
2020 return ERROR_INVALID_ARGUMENTS
;
2025 /* combination (options for broken wiring) */
2026 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2027 if (strcmp(*args
, "separate") == 0)
2028 /* separate reset lines - default */;
2029 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2030 tmp
|= RESET_SRST_PULLS_TRST
;
2031 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2032 tmp
|= RESET_TRST_PULLS_SRST
;
2033 else if (strcmp(*args
, "combined") == 0)
2034 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2038 LOG_ERROR("extra reset_config %s spec (%s)",
2039 "combination", *args
);
2040 return ERROR_INVALID_ARGUMENTS
;
2045 /* trst_type (NOP without HAS_TRST) */
2046 m
= RESET_TRST_OPEN_DRAIN
;
2047 if (strcmp(*args
, "trst_open_drain") == 0)
2048 tmp
|= RESET_TRST_OPEN_DRAIN
;
2049 else if (strcmp(*args
, "trst_push_pull") == 0)
2050 /* push/pull from adapter - default */;
2054 LOG_ERROR("extra reset_config %s spec (%s)",
2055 "trst_type", *args
);
2056 return ERROR_INVALID_ARGUMENTS
;
2061 /* srst_type (NOP without HAS_SRST) */
2062 m
|= RESET_SRST_PUSH_PULL
;
2063 if (strcmp(*args
, "srst_push_pull") == 0)
2064 tmp
|= RESET_SRST_PUSH_PULL
;
2065 else if (strcmp(*args
, "srst_open_drain") == 0)
2066 /* open drain from adapter - default */;
2070 LOG_ERROR("extra reset_config %s spec (%s)",
2071 "srst_type", *args
);
2072 return ERROR_INVALID_ARGUMENTS
;
2077 /* caller provided nonsense; fail */
2078 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2079 return ERROR_INVALID_ARGUMENTS
;
2082 /* Remember the bits which were specified (mask)
2083 * and their new values (new_cfg).
2089 /* clear previous values of those bits, save new values */
2090 jtag_reset_config
&= ~mask
;
2091 jtag_reset_config
|= new_cfg
;
2096 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2097 char *cmd
, char **args
, int argc
)
2100 return ERROR_COMMAND_SYNTAX_ERROR
;
2102 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2103 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2107 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2108 char *cmd
, char **args
, int argc
)
2111 return ERROR_COMMAND_SYNTAX_ERROR
;
2113 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2114 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2118 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2120 int retval
= ERROR_OK
;
2123 return ERROR_COMMAND_SYNTAX_ERROR
;
2126 LOG_DEBUG("handle jtag speed");
2129 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2131 /* this command can be called during CONFIG,
2132 * in which case jtag isn't initialized */
2134 retval
= jtag
->speed(cur_speed
);
2136 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2141 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2144 return ERROR_COMMAND_SYNTAX_ERROR
;
2146 int retval
= ERROR_OK
;
2150 LOG_DEBUG("handle jtag khz");
2152 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2155 LOG_DEBUG("have interface set up");
2157 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2158 if (ERROR_OK
!= retval
)
2160 jtag_set_speed_khz(0);
2163 cur_speed
= jtag_speed
= speed_div1
;
2165 retval
= jtag
->speed(cur_speed
);
2171 cur_speed
= jtag_get_speed_khz();
2174 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2175 if (ERROR_OK
!= retval
)
2180 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2182 command_print(cmd_ctx
, "RCLK - adaptive");
2187 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
2188 char *cmd
, char **args
, int argc
)
2191 return ERROR_COMMAND_SYNTAX_ERROR
;
2194 if (args
[0][0] == '1')
2196 else if (args
[0][0] == '0')
2199 return ERROR_COMMAND_SYNTAX_ERROR
;
2202 if (args
[1][0] == '1')
2204 else if (args
[1][0] == '0')
2207 return ERROR_COMMAND_SYNTAX_ERROR
;
2209 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2210 return ERROR_JTAG_INIT_FAILED
;
2212 jtag_add_reset(trst
, srst
);
2213 jtag_execute_queue();
2218 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
2219 char *cmd
, char **args
, int argc
)
2222 return ERROR_COMMAND_SYNTAX_ERROR
;
2224 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2225 jtag_execute_queue();
2231 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2232 * should be stable ... and *NOT* a shift state, otherwise free-running
2233 * jtag clocks could change the values latched by the update state.
2235 static bool scan_is_safe(tap_state_t state
)
2250 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2253 scan_field_t
*fields
;
2255 tap_state_t endstate
;
2257 if ((argc
< 2) || (argc
% 2))
2259 return ERROR_COMMAND_SYNTAX_ERROR
;
2262 /* optional "-endstate" "statename" at the end of the arguments,
2263 * so that e.g. IRPAUSE can let us load the data register before
2264 * entering RUN/IDLE to execute the instruction we load here.
2266 endstate
= TAP_IDLE
;
2269 /* have at least one pair of numbers. */
2270 /* is last pair the magic text? */
2271 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2274 cpA
= args
[ argc
-1 ];
2275 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2276 cpS
= tap_state_name( endstate
);
2277 if( 0 == strcmp( cpA
, cpS
) ){
2281 if( endstate
>= TAP_NUM_STATES
){
2282 return ERROR_COMMAND_SYNTAX_ERROR
;
2284 if (!scan_is_safe(endstate
))
2285 LOG_WARNING("irscan with unsafe "
2286 "endstate \"%s\"", cpA
);
2287 /* found - remove the last 2 args */
2293 int num_fields
= argc
/ 2;
2295 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2297 for (i
= 0; i
< num_fields
; i
++)
2299 tap
= jtag_tap_by_string( args
[i
*2] );
2302 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2305 int field_size
= tap
->ir_length
;
2306 fields
[i
].tap
= tap
;
2307 fields
[i
].num_bits
= field_size
;
2308 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2309 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2310 fields
[i
].in_value
= NULL
;
2313 /* did we have an endstate? */
2314 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2316 int retval
=jtag_execute_queue();
2318 for (i
= 0; i
< num_fields
; i
++)
2319 free(fields
[i
].out_value
);
2326 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2329 scan_field_t
*fields
;
2331 int field_count
= 0;
2334 tap_state_t endstate
;
2337 * args[2] = num_bits
2338 * args[3] = hex string
2339 * ... repeat num bits and hex string ...
2342 * args[N-2] = "-endstate"
2343 * args[N-1] = statename
2345 if ((argc
< 4) || ((argc
% 2)!=0))
2347 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2351 endstate
= TAP_IDLE
;
2353 /* validate arguments as numbers */
2355 for (i
= 2; i
< argc
; i
+=2)
2360 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2361 /* If valid - try next arg */
2366 /* Not valid.. are we at the end? */
2367 if ( ((i
+2) != argc
) ){
2368 /* nope, then error */
2372 /* it could be: "-endstate FOO"
2373 * e.g. DRPAUSE so we can issue more instructions
2374 * before entering RUN/IDLE and executing them.
2377 /* get arg as a string. */
2378 cp
= Jim_GetString( args
[i
], NULL
);
2379 /* is it the magic? */
2380 if( 0 == strcmp( "-endstate", cp
) ){
2381 /* is the statename valid? */
2382 cp
= Jim_GetString( args
[i
+1], NULL
);
2384 /* see if it is a valid state name */
2385 endstate
= tap_state_by_name(cp
);
2387 /* update the error message */
2388 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2390 if (!scan_is_safe(endstate
))
2391 LOG_WARNING("drscan with unsafe "
2392 "endstate \"%s\"", cp
);
2394 /* valid - so clear the error */
2396 /* and remove the last 2 args */
2401 /* Still an error? */
2403 return e
; /* too bad */
2405 } /* validate args */
2407 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2412 num_fields
=(argc
-2)/2;
2413 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2414 for (i
= 2; i
< argc
; i
+=2)
2420 Jim_GetLong(interp
, args
[i
], &bits
);
2421 str
= Jim_GetString(args
[i
+1], &len
);
2423 fields
[field_count
].tap
= tap
;
2424 fields
[field_count
].num_bits
= bits
;
2425 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2426 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2427 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2431 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2433 retval
= jtag_execute_queue();
2434 if (retval
!= ERROR_OK
)
2436 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2441 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2442 for (i
= 2; i
< argc
; i
+=2)
2447 Jim_GetLong(interp
, args
[i
], &bits
);
2448 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2449 free(fields
[field_count
].out_value
);
2451 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2456 Jim_SetResult(interp
, list
);
2464 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2466 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2472 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2476 if (strcmp(args
[0], "enable") == 0)
2478 jtag_verify_capture_ir
= 1;
2480 else if (strcmp(args
[0], "disable") == 0)
2482 jtag_verify_capture_ir
= 0;
2485 return ERROR_COMMAND_SYNTAX_ERROR
;
2487 } else if (argc
!= 0)
2489 return ERROR_COMMAND_SYNTAX_ERROR
;
2492 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2497 void jtag_set_verify(bool enable
)
2499 jtag_verify
= enable
;
2502 bool jtag_will_verify()
2507 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2510 return ERROR_COMMAND_SYNTAX_ERROR
;
2514 if (strcmp(args
[0], "enable") == 0)
2515 jtag_set_verify(true);
2516 else if (strcmp(args
[0], "disable") == 0)
2517 jtag_set_verify(false);
2519 return ERROR_COMMAND_SYNTAX_ERROR
;
2522 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2523 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2529 int jtag_power_dropout(int *dropout
)
2531 return jtag
->power_dropout(dropout
);
2534 int jtag_srst_asserted(int *srst_asserted
)
2536 return jtag
->srst_asserted(srst_asserted
);
2539 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2541 jtag_tap_event_action_t
* jteap
;
2544 jteap
= tap
->event_action
;
2548 if (jteap
->event
== e
) {
2550 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2553 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2554 Jim_GetString(jteap
->body
, NULL
) );
2555 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2556 Jim_PrintErrorMessage(interp
);
2560 jteap
= jteap
->next
;
2564 LOG_DEBUG( "event %d %s - no action",
2566 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2570 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2573 return ERROR_COMMAND_SYNTAX_ERROR
;
2578 if (strcmp(args
[0], "short") == 0)
2579 use_new_table
= true;
2580 else if (strcmp(args
[0], "long") == 0)
2581 use_new_table
= false;
2583 return ERROR_COMMAND_SYNTAX_ERROR
;
2585 tap_use_new_tms_table(use_new_table
);
2588 command_print(cmd_ctx
, "tms sequence is %s",
2589 tap_uses_new_tms_table() ? "short": "long");
2595 * Function jtag_add_statemove
2596 * moves from the current state to the goal \a state. This needs
2597 * to be handled according to the xsvf spec, see the XSTATE command
2600 int jtag_add_statemove(tap_state_t goal_state
)
2602 int retval
= ERROR_OK
;
2604 tap_state_t moves
[8];
2605 tap_state_t cur_state
= cmd_queue_cur_state
;
2610 LOG_DEBUG( "cur_state=%s goal_state=%s",
2611 tap_state_name(cur_state
),
2612 tap_state_name(goal_state
) );
2615 /* From the XSVF spec, pertaining to XSTATE:
2617 For special states known as stable states (Test-Logic-Reset,
2618 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2619 predefined TAP state paths when the starting state is a stable state and
2620 when the XSTATE specifies a new stable state (see the STATE command in
2621 the [Ref 5] for the TAP state paths between stable states). For
2622 non-stable states, XSTATE should specify a state that is only one TAP
2623 state transition distance from the current TAP state to avoid undefined
2624 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2625 transition the TAP through a specific state path.
2628 if (goal_state
==cur_state
)
2629 ; /* nothing to do */
2631 else if( goal_state
==TAP_RESET
)
2636 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2638 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2639 spec, then this code is not fully conformant to the xsvf spec. This
2640 puts a burden on tap_get_tms_path() function from the xsvf spec.
2641 If in doubt, you should confirm that that burden is being met.
2644 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2645 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2647 assert( (unsigned) tms_count
< DIM(moves
) );
2649 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2651 bool bit
= tms_bits
& 1;
2653 cur_state
= tap_state_transition(cur_state
, bit
);
2654 moves
[i
] = cur_state
;
2657 jtag_add_pathmove(tms_count
, moves
);
2660 /* else state must be immediately reachable in one clock cycle, and does not
2661 need to be a stable state.
2663 else if( tap_state_transition(cur_state
, true) == goal_state
2664 || tap_state_transition(cur_state
, false) == goal_state
)
2666 /* move a single state */
2667 moves
[0] = goal_state
;
2668 jtag_add_pathmove( 1, moves
);
2673 retval
= ERROR_FAIL
;
2679 void jtag_set_nsrst_delay(unsigned delay
)
2681 jtag_nsrst_delay
= delay
;
2683 unsigned jtag_get_nsrst_delay(void)
2685 return jtag_nsrst_delay
;
2687 void jtag_set_ntrst_delay(unsigned delay
)
2689 jtag_ntrst_delay
= delay
;
2691 unsigned jtag_get_ntrst_delay(void)
2693 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)