1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
17 * This program is distributed in the hope that it will be useful, *
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
20 * GNU General Public License for more details. *
22 * You should have received a copy of the GNU General Public License *
23 * along with this program; if not, write to the *
24 * Free Software Foundation, Inc., *
25 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
26 ***************************************************************************/
32 #include "minidriver.h"
33 #include "interface.h"
40 /// The number of JTAG queue flushes (for profiling and debugging purposes).
41 static int jtag_flush_queue_count
;
43 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
44 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
);
46 /* note that this is not marked as static as it must be available from outside jtag.c for those
47 that implement the jtag_xxx() minidriver layer
49 int jtag_error
=ERROR_OK
;
51 char* jtag_event_strings
[] =
53 "JTAG controller reset (RESET or TRST)"
56 const Jim_Nvp nvp_jtag_tap_event
[] = {
57 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
58 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
60 { .name
= NULL
, .value
= -1 }
67 * List all TAPs that have been created.
69 static jtag_tap_t
*__jtag_all_taps
= NULL
;
71 * The number of TAPs in the __jtag_all_taps list, used to track the
72 * assigned chain position to new TAPs
74 static int jtag_num_taps
= 0;
76 enum reset_types jtag_reset_config
= RESET_NONE
;
77 tap_state_t cmd_queue_end_state
= TAP_RESET
;
78 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
80 int jtag_verify_capture_ir
= 1;
83 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
84 static int jtag_nsrst_delay
= 0; /* default to no nSRST delay */
85 static int jtag_ntrst_delay
= 0; /* default to no nTRST delay */
87 /* callbacks to inform high-level handlers about JTAG state changes */
88 jtag_event_callback_t
*jtag_event_callbacks
;
91 static int speed_khz
= 0;
92 /* flag if the kHz speed was defined */
93 static bool hasKHz
= false;
95 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
98 #if BUILD_ECOSBOARD == 1
99 extern jtag_interface_t zy1000_interface
;
100 #elif defined(BUILD_MINIDRIVER_DUMMY)
101 extern jtag_interface_t minidummy_interface
;
102 #else // standard drivers
103 #if BUILD_PARPORT == 1
104 extern jtag_interface_t parport_interface
;
108 extern jtag_interface_t dummy_interface
;
111 #if BUILD_FT2232_FTD2XX == 1
112 extern jtag_interface_t ft2232_interface
;
115 #if BUILD_FT2232_LIBFTDI == 1
116 extern jtag_interface_t ft2232_interface
;
119 #if BUILD_AMTJTAGACCEL == 1
120 extern jtag_interface_t amt_jtagaccel_interface
;
123 #if BUILD_EP93XX == 1
124 extern jtag_interface_t ep93xx_interface
;
127 #if BUILD_AT91RM9200 == 1
128 extern jtag_interface_t at91rm9200_interface
;
131 #if BUILD_GW16012 == 1
132 extern jtag_interface_t gw16012_interface
;
135 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
136 extern jtag_interface_t presto_interface
;
139 #if BUILD_USBPROG == 1
140 extern jtag_interface_t usbprog_interface
;
144 extern jtag_interface_t jlink_interface
;
147 #if BUILD_VSLLINK == 1
148 extern jtag_interface_t vsllink_interface
;
152 extern jtag_interface_t rlink_interface
;
155 #if BUILD_ARMJTAGEW == 1
156 extern jtag_interface_t armjtagew_interface
;
158 #endif // standard drivers
161 * The list of built-in JTAG interfaces, containing entries for those
162 * drivers that were enabled by the @c configure script.
164 * The list should be defined to contain either one minidriver interface
165 * or some number of standard driver interfaces, never both.
167 jtag_interface_t
*jtag_interfaces
[] = {
168 #if BUILD_ECOSBOARD == 1
170 #elif defined(BUILD_MINIDRIVER_DUMMY)
171 &minidummy_interface
,
172 #else // standard drivers
173 #if BUILD_PARPORT == 1
179 #if BUILD_FT2232_FTD2XX == 1
182 #if BUILD_FT2232_LIBFTDI == 1
185 #if BUILD_AMTJTAGACCEL == 1
186 &amt_jtagaccel_interface
,
188 #if BUILD_EP93XX == 1
191 #if BUILD_AT91RM9200 == 1
192 &at91rm9200_interface
,
194 #if BUILD_GW16012 == 1
197 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
200 #if BUILD_USBPROG == 1
206 #if BUILD_VSLLINK == 1
212 #if BUILD_ARMJTAGEW == 1
213 &armjtagew_interface
,
215 #endif // standard drivers
219 struct jtag_interface_s
*jtag
= NULL
;
222 static jtag_interface_t
*jtag_interface
= NULL
;
226 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
227 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
228 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
229 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
230 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
231 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
232 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
234 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
236 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
237 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
238 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
239 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
240 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
242 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
243 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
244 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
246 jtag_tap_t
*jtag_all_taps(void)
248 return __jtag_all_taps
;
251 int jtag_tap_count(void)
253 return jtag_num_taps
;
256 unsigned jtag_tap_count_enabled(void)
272 /// Append a new TAP to the chain of all taps.
273 static void jtag_tap_add(struct jtag_tap_s
*t
)
275 t
->abs_chain_position
= jtag_num_taps
++;
277 jtag_tap_t
**tap
= &__jtag_all_taps
;
279 tap
= &(*tap
)->next_tap
;
283 jtag_tap_t
*jtag_tap_by_string( const char *s
)
291 if( 0 == strcmp( t
->dotted_name
, s
) ){
297 /* backup plan is by number */
299 /* ok - is "s" a number? */
301 n
= strtol( s
, &cp
, 0 );
302 if( (s
!= cp
) && (*cp
== 0) ){
304 t
= jtag_tap_by_abs_position(n
);
310 jtag_tap_t
* jtag_tap_by_jim_obj( Jim_Interp
*interp
, Jim_Obj
*o
)
315 cp
= Jim_GetString( o
, NULL
);
320 t
= jtag_tap_by_string( cp
);
323 Jim_SetResult_sprintf(interp
,"Tap: %s is unknown", cp
);
328 /* returns a pointer to the n-th device in the scan chain */
329 jtag_tap_t
* jtag_tap_by_abs_position( int n
)
337 while( t
&& (n
> 0)) {
344 const char *jtag_tap_name(const jtag_tap_t
*tap
)
346 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
350 int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
)
352 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
354 if (callback
== NULL
)
356 return ERROR_INVALID_ARGUMENTS
;
361 while ((*callbacks_p
)->next
)
362 callbacks_p
= &((*callbacks_p
)->next
);
363 callbacks_p
= &((*callbacks_p
)->next
);
366 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
367 (*callbacks_p
)->callback
= callback
;
368 (*callbacks_p
)->priv
= priv
;
369 (*callbacks_p
)->next
= NULL
;
374 int jtag_unregister_event_callback(int (*callback
)(enum jtag_event event
, void *priv
))
376 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
378 if (callback
== NULL
)
380 return ERROR_INVALID_ARGUMENTS
;
385 jtag_event_callback_t
**next
= &((*callbacks_p
)->next
);
386 if ((*callbacks_p
)->callback
== callback
)
389 *callbacks_p
= *next
;
397 int jtag_call_event_callbacks(enum jtag_event event
)
399 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
401 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
405 callback
->callback(event
, callback
->priv
);
406 callback
= callback
->next
;
412 static void jtag_checks(void)
414 assert(jtag_trst
== 0);
417 static void jtag_prelude(tap_state_t state
)
421 assert(state
!=TAP_INVALID
);
423 cmd_queue_cur_state
= state
;
426 void jtag_alloc_in_value32(scan_field_t
*field
)
428 interface_jtag_alloc_in_value32(field
);
431 void jtag_add_ir_scan_noverify(int in_count
, const scan_field_t
*in_fields
,
436 int retval
= interface_jtag_add_ir_scan(in_count
, in_fields
, state
);
437 jtag_set_error(retval
);
442 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
444 * If the input field list contains an instruction value for a TAP then that is used
445 * otherwise the TAP is set to bypass.
447 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
450 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
452 if (jtag_verify
&&jtag_verify_capture_ir
)
454 /* 8 x 32 bit id's is enough for all invocations */
456 for (int j
= 0; j
< in_num_fields
; j
++)
458 /* if we are to run a verification of the ir scan, we need to get the input back.
459 * We may have to allocate space if the caller didn't ask for the input back.
461 in_fields
[j
].check_value
=in_fields
[j
].tap
->expected
;
462 in_fields
[j
].check_mask
=in_fields
[j
].tap
->expected_mask
;
464 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
467 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
472 * Duplicate the scan fields passed into the function into an IR SCAN command
474 * This function assumes that the caller handles extra fields for bypassed TAPs
477 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
,
482 int retval
= interface_jtag_add_plain_ir_scan(
483 in_num_fields
, in_fields
, state
);
484 jtag_set_error(retval
);
487 void jtag_add_callback(jtag_callback1_t f
, u8
*in
)
489 interface_jtag_add_callback(f
, in
);
492 void jtag_add_callback4(jtag_callback_t f
, u8
*in
,
493 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
494 jtag_callback_data_t data3
)
496 interface_jtag_add_callback4(f
, in
, data1
, data2
, data3
);
499 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
);
501 static int jtag_check_value_mask_callback(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
503 return jtag_check_value_inner(in
, (u8
*)data1
, (u8
*)data2
, (int)data3
);
506 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
507 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
509 for (int i
= 0; i
< in_num_fields
; i
++)
511 struct scan_field_s
*field
= &in_fields
[i
];
512 field
->allocated
= 0;
514 if (field
->check_value
|| field
->in_value
)
516 interface_jtag_add_scan_check_alloc(field
);
520 jtag_add_scan(in_num_fields
, in_fields
, state
);
522 for (int i
= 0; i
< in_num_fields
; i
++)
524 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
526 /* this is synchronous for a minidriver */
527 jtag_add_callback4(jtag_check_value_mask_callback
, in_fields
[i
].in_value
,
528 (jtag_callback_data_t
)in_fields
[i
].check_value
,
529 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
530 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
532 if (in_fields
[i
].allocated
)
534 free(in_fields
[i
].in_value
);
536 if (in_fields
[i
].modified
)
538 in_fields
[i
].in_value
= NULL
;
543 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
547 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
550 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
556 * Generate a DR SCAN using the fields passed to the function.
557 * For connected TAPs, the function checks in_fields and uses fields
558 * specified there. For bypassed TAPs, the function generates a dummy
559 * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan().
561 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
567 retval
= interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
568 jtag_set_error(retval
);
572 * Duplicate the scan fields passed into the function into a DR SCAN
573 * command. Unlike jtag_add_dr_scan(), this function assumes that the
574 * caller handles extra fields for bypassed TAPs.
576 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
,
582 retval
= interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
583 jtag_set_error(retval
);
586 void jtag_add_dr_out(jtag_tap_t
* tap
,
587 int num_fields
, const int* num_bits
, const u32
* value
,
588 tap_state_t end_state
)
590 assert(end_state
!= TAP_INVALID
);
592 cmd_queue_cur_state
= end_state
;
594 interface_jtag_add_dr_out(tap
,
595 num_fields
, num_bits
, value
,
599 void jtag_add_tlr(void)
601 jtag_prelude(TAP_RESET
);
604 retval
=interface_jtag_add_tlr();
605 if (retval
!=ERROR_OK
)
608 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
611 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
613 tap_state_t cur_state
= cmd_queue_cur_state
;
617 /* the last state has to be a stable state */
618 if (!tap_is_state_stable(path
[num_states
- 1]))
620 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
624 for (i
=0; i
<num_states
; i
++)
626 if (path
[i
] == TAP_RESET
)
628 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
632 if ( tap_state_transition(cur_state
, true) != path
[i
]
633 && tap_state_transition(cur_state
, false) != path
[i
])
635 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[i
]));
643 retval
= interface_jtag_add_pathmove(num_states
, path
);
644 cmd_queue_cur_state
= path
[num_states
- 1];
645 if (retval
!=ERROR_OK
)
649 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
655 /* executed by sw or hw fifo */
656 retval
=interface_jtag_add_runtest(num_cycles
, state
);
657 if (retval
!=ERROR_OK
)
662 void jtag_add_clocks( int num_cycles
)
666 if( !tap_is_state_stable(cmd_queue_cur_state
) )
668 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
669 tap_state_name(cmd_queue_cur_state
) );
670 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
678 retval
= interface_jtag_add_clocks(num_cycles
);
679 if (retval
!= ERROR_OK
)
684 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
686 int trst_with_tlr
= 0;
689 /* FIX!!! there are *many* different cases here. A better
690 * approach is needed for legal combinations of transitions...
692 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
693 (jtag_reset_config
& RESET_HAS_TRST
)&&
694 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
696 if (((req_tlr_or_trst
&&!jtag_trst
)||
697 (!req_tlr_or_trst
&&jtag_trst
))&&
698 ((req_srst
&&!jtag_srst
)||
699 (!req_srst
&&jtag_srst
)))
701 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
702 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
706 /* Make sure that jtag_reset_config allows the requested reset */
707 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
708 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
710 LOG_ERROR("BUG: requested reset would assert trst");
711 jtag_error
=ERROR_FAIL
;
715 /* if TRST pulls SRST, we reset with TAP T-L-R */
716 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
721 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
723 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
724 jtag_error
=ERROR_FAIL
;
730 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
742 jtag_srst
= req_srst
;
744 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
745 if (retval
!=ERROR_OK
)
750 jtag_execute_queue();
754 LOG_DEBUG("SRST line asserted");
758 LOG_DEBUG("SRST line released");
759 if (jtag_nsrst_delay
)
760 jtag_add_sleep(jtag_nsrst_delay
* 1000);
765 LOG_DEBUG("JTAG reset with RESET instead of TRST");
766 jtag_set_end_state(TAP_RESET
);
773 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
774 * and inform possible listeners about this
776 LOG_DEBUG("TRST line asserted");
777 tap_set_state(TAP_RESET
);
778 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
782 if (jtag_ntrst_delay
)
783 jtag_add_sleep(jtag_ntrst_delay
* 1000);
787 tap_state_t
jtag_set_end_state(tap_state_t state
)
789 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
791 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
794 if (state
!=TAP_INVALID
)
795 cmd_queue_end_state
= state
;
796 return cmd_queue_end_state
;
799 tap_state_t
jtag_get_end_state(void)
801 return cmd_queue_end_state
;
804 void jtag_add_sleep(u32 us
)
806 keep_alive(); /* we might be running on a very slow JTAG clk */
807 int retval
=interface_jtag_add_sleep(us
);
808 if (retval
!=ERROR_OK
)
813 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
815 int retval
= ERROR_OK
;
817 int compare_failed
= 0;
820 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
822 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
825 /* An error handler could have caught the failing check
826 * only report a problem when there wasn't a handler, or if the handler
827 * acknowledged the error
830 LOG_WARNING("TAP %s:",
831 jtag_tap_name(field->tap));
835 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
836 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
840 char *in_check_mask_char
;
841 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
842 LOG_WARNING("value captured during scan didn't pass the requested check:");
843 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
844 captured_char
, in_check_value_char
, in_check_mask_char
);
845 free(in_check_mask_char
);
849 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
);
853 free(in_check_value_char
);
855 retval
= ERROR_JTAG_QUEUE_FAILED
;
862 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
864 assert(field
->in_value
!= NULL
);
868 /* no checking to do */
872 jtag_execute_queue_noclear();
874 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
875 jtag_set_error(retval
);
880 int default_interface_jtag_execute_queue(void)
884 LOG_ERROR("No JTAG interface configured yet. "
885 "Issue 'init' command in startup scripts "
886 "before communicating with targets.");
890 return jtag
->execute_queue();
893 void jtag_execute_queue_noclear(void)
895 jtag_flush_queue_count
++;
896 jtag_set_error(interface_jtag_execute_queue());
899 int jtag_get_flush_queue_count(void)
901 return jtag_flush_queue_count
;
904 int jtag_execute_queue(void)
906 jtag_execute_queue_noclear();
907 return jtag_error_clear();
910 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
912 jtag_tap_t
*tap
= priv
;
916 if (event
== JTAG_TRST_ASSERTED
)
918 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
925 void jtag_sleep(u32 us
)
927 alive_sleep(us
/1000);
930 /// maximum number of JTAG devices expected in the chain
931 #define JTAG_MAX_CHAIN_SIZE 20
933 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
934 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
935 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
937 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
939 scan_field_t field
= {
941 .num_bits
= num_idcode
* 32,
942 .out_value
= idcode_buffer
,
943 .in_value
= idcode_buffer
,
946 // initialize to the end of chain ID value
947 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
948 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
950 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
951 return jtag_execute_queue();
954 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
959 for (unsigned i
= 0; i
< count
* 4; i
++)
961 zero_check
|= idcodes
[i
];
962 one_check
&= idcodes
[i
];
965 /* if there wasn't a single non-zero bit or if all bits were one,
966 * the scan is not valid */
967 if (zero_check
== 0x00 || one_check
== 0xff)
969 LOG_ERROR("JTAG communication failure: check connection, "
970 "JTAG interface, target power etc.");
976 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
977 const char *name
, u32 idcode
)
979 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
980 "JTAG tap: %s %16.16s: 0x%08x "
981 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
983 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
986 static bool jtag_idcode_is_final(u32 idcode
)
988 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
992 * This helper checks that remaining bits in the examined chain data are
993 * all as expected, but a single JTAG device requires only 64 bits to be
994 * read back correctly. This can help identify and diagnose problems
995 * with the JTAG chain earlier, gives more helpful/explicit error messages.
997 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
999 bool triggered
= false;
1000 for ( ; count
< max
- 31; count
+= 32)
1002 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
1003 // do not trigger the warning if the data looks good
1004 if (!triggered
&& jtag_idcode_is_final(idcode
))
1006 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1012 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1014 if (0 == tap
->expected_ids_cnt
)
1016 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1018 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1019 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1024 /* Loop over the expected identification codes and test for a match */
1026 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1028 if (tap
->idcode
== tap
->expected_ids
[ii
])
1032 /* If none of the expected ids matched, log an error */
1033 if (ii
!= tap
->expected_ids_cnt
)
1035 LOG_INFO("JTAG Tap/device matched");
1038 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1039 tap
->dotted_name
, tap
->idcode
);
1040 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1043 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1044 ii
+ 1, tap
->expected_ids_cnt
);
1045 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1046 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1051 /* Try to examine chain layout according to IEEE 1149.1 §12
1053 static int jtag_examine_chain(void)
1055 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1056 unsigned device_count
= 0;
1058 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1060 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1061 return ERROR_JTAG_INIT_FAILED
;
1063 /* point at the 1st tap */
1064 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1067 LOG_ERROR("JTAG: No taps enabled?");
1068 return ERROR_JTAG_INIT_FAILED
;
1071 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1073 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1074 if ((idcode
& 1) == 0)
1076 /* LSB must not be 0, this indicates a device in bypass */
1077 LOG_WARNING("Tap/Device does not have IDCODE");
1085 * End of chain (invalid manufacturer ID) some devices, such
1086 * as AVR will output all 1's instead of TDI input value at
1089 if (jtag_idcode_is_final(idcode
))
1091 jtag_examine_chain_end(idcode_buffer
,
1092 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1096 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1097 tap
? tap
->dotted_name
: "(not-named)",
1106 tap
->idcode
= idcode
;
1108 // ensure the TAP ID does matches what was expected
1109 if (!jtag_examine_chain_match_tap(tap
))
1110 return ERROR_JTAG_INIT_FAILED
;
1112 tap
= jtag_tap_next_enabled(tap
);
1115 /* see if number of discovered devices matches configuration */
1116 if (device_count
!= jtag_tap_count_enabled())
1118 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1119 "does not match (enabled) configuration (%i), total taps: %d",
1120 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1121 LOG_ERROR("check the config file and ensure proper JTAG communication"
1122 " (connections, speed, ...)");
1123 return ERROR_JTAG_INIT_FAILED
;
1129 static int jtag_validate_chain(void)
1132 int total_ir_length
= 0;
1138 total_ir_length
= 0;
1140 tap
= jtag_tap_next_enabled(tap
);
1144 total_ir_length
+= tap
->ir_length
;
1147 total_ir_length
+= 2;
1148 ir_test
= malloc(CEIL(total_ir_length
, 8));
1149 buf_set_ones(ir_test
, total_ir_length
);
1152 field
.num_bits
= total_ir_length
;
1153 field
.out_value
= ir_test
;
1154 field
.in_value
= ir_test
;
1157 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1158 jtag_execute_queue();
1164 tap
= jtag_tap_next_enabled(tap
);
1169 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1172 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1173 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
);
1176 return ERROR_JTAG_INIT_FAILED
;
1178 chain_pos
+= tap
->ir_length
;
1181 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1184 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1185 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
);
1188 return ERROR_JTAG_INIT_FAILED
;
1196 enum jtag_tap_cfg_param
{
1200 static Jim_Nvp nvp_config_opts
[] = {
1201 { .name
= "-event", .value
= JCFG_EVENT
},
1203 { .name
= NULL
, .value
= -1 }
1206 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1212 /* parse config or cget options */
1213 while (goi
->argc
> 0) {
1214 Jim_SetEmptyResult (goi
->interp
);
1216 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1218 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1224 if (goi
->argc
== 0) {
1225 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1229 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1231 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1235 if (goi
->isconfigure
) {
1236 if (goi
->argc
!= 1) {
1237 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1241 if (goi
->argc
!= 0) {
1242 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1248 jtag_tap_event_action_t
*jteap
;
1250 jteap
= tap
->event_action
;
1251 /* replace existing? */
1253 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1256 jteap
= jteap
->next
;
1259 if (goi
->isconfigure
) {
1260 if (jteap
== NULL
) {
1262 jteap
= calloc(1, sizeof (*jteap
));
1264 jteap
->event
= n
->value
;
1265 Jim_GetOpt_Obj( goi
, &o
);
1267 Jim_DecrRefCount(interp
, jteap
->body
);
1269 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1270 Jim_IncrRefCount(jteap
->body
);
1272 /* add to head of event list */
1273 jteap
->next
= tap
->event_action
;
1274 tap
->event_action
= jteap
;
1275 Jim_SetEmptyResult(goi
->interp
);
1278 if (jteap
== NULL
) {
1279 Jim_SetEmptyResult(goi
->interp
);
1281 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1288 } /* while (goi->argc) */
1294 static void jtag_tap_init(jtag_tap_t
*tap
)
1296 assert(0 != tap
->ir_length
);
1298 tap
->expected
= malloc(tap
->ir_length
);
1299 tap
->expected_mask
= malloc(tap
->ir_length
);
1300 tap
->cur_instr
= malloc(tap
->ir_length
);
1302 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1303 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1304 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1306 // place TAP in bypass mode
1308 // register the reset callback for the TAP
1309 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1311 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1312 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1313 tap
->abs_chain_position
, tap
->ir_length
,
1314 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1318 static void jtag_tap_free(jtag_tap_t
*tap
)
1320 /// @todo is anything missing? no memory leaks please
1321 free((void *)tap
->expected_ids
);
1322 free((void *)tap
->chip
);
1323 free((void *)tap
->tapname
);
1324 free((void *)tap
->dotted_name
);
1328 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1337 const Jim_Nvp opts
[] = {
1338 #define NTAP_OPT_IRLEN 0
1339 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1340 #define NTAP_OPT_IRMASK 1
1341 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1342 #define NTAP_OPT_IRCAPTURE 2
1343 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1344 #define NTAP_OPT_ENABLED 3
1345 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1346 #define NTAP_OPT_DISABLED 4
1347 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1348 #define NTAP_OPT_EXPECTED_ID 5
1349 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1350 { .name
= NULL
, .value
= -1 },
1353 pTap
= malloc( sizeof(jtag_tap_t
) );
1354 memset( pTap
, 0, sizeof(*pTap
) );
1356 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1360 * we expect CHIP + TAP + OPTIONS
1362 if( goi
->argc
< 3 ){
1363 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1366 Jim_GetOpt_String( goi
, &cp
, NULL
);
1367 pTap
->chip
= strdup(cp
);
1369 Jim_GetOpt_String( goi
, &cp
, NULL
);
1370 pTap
->tapname
= strdup(cp
);
1372 /* name + dot + name + null */
1373 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1375 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1376 pTap
->dotted_name
= cp
;
1378 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1379 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1381 /* default is enabled */
1384 /* deal with options */
1385 #define NTREQ_IRLEN 1
1386 #define NTREQ_IRCAPTURE 2
1387 #define NTREQ_IRMASK 4
1389 /* clear them as we find them */
1390 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1393 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1395 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1398 LOG_DEBUG("Processing option: %s", n
->name
);
1400 case NTAP_OPT_ENABLED
:
1403 case NTAP_OPT_DISABLED
:
1406 case NTAP_OPT_EXPECTED_ID
:
1408 u32
*new_expected_ids
;
1410 e
= Jim_GetOpt_Wide( goi
, &w
);
1412 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1416 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1417 if (new_expected_ids
== NULL
) {
1418 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1422 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1424 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1426 free(pTap
->expected_ids
);
1427 pTap
->expected_ids
= new_expected_ids
;
1428 pTap
->expected_ids_cnt
++;
1431 case NTAP_OPT_IRLEN
:
1432 case NTAP_OPT_IRMASK
:
1433 case NTAP_OPT_IRCAPTURE
:
1434 e
= Jim_GetOpt_Wide( goi
, &w
);
1436 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1439 if( (w
< 0) || (w
> 0xffff) ){
1441 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1442 n
->name
, (int)(w
), (int)(w
));
1446 case NTAP_OPT_IRLEN
:
1447 pTap
->ir_length
= w
;
1448 reqbits
&= (~(NTREQ_IRLEN
));
1450 case NTAP_OPT_IRMASK
:
1451 pTap
->ir_capture_mask
= w
;
1452 reqbits
&= (~(NTREQ_IRMASK
));
1454 case NTAP_OPT_IRCAPTURE
:
1455 pTap
->ir_capture_value
= w
;
1456 reqbits
&= (~(NTREQ_IRCAPTURE
));
1459 } /* switch(n->value) */
1460 } /* while( goi->argc ) */
1462 /* Did all the required option bits get cleared? */
1465 jtag_tap_init(pTap
);
1469 Jim_SetResult_sprintf(goi
->interp
,
1470 "newtap: %s missing required parameters",
1472 jtag_tap_free(pTap
);
1476 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1482 struct command_context_s
*context
;
1486 JTAG_CMD_INIT_RESET
,
1489 JTAG_CMD_TAPDISABLE
,
1490 JTAG_CMD_TAPISENABLED
,
1495 const Jim_Nvp jtag_cmds
[] = {
1496 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1497 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1498 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1499 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1500 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1501 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1502 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1503 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1505 { .name
= NULL
, .value
= -1 },
1508 context
= Jim_GetAssocData(interp
, "context");
1509 /* go past the command */
1510 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1512 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1514 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1517 Jim_SetEmptyResult( goi
.interp
);
1519 case JTAG_CMD_INTERFACE
:
1520 /* return the name of the interface */
1521 /* TCL code might need to know the exact type... */
1522 /* FUTURE: we allow this as a means to "set" the interface. */
1523 if( goi
.argc
!= 0 ){
1524 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1527 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1529 case JTAG_CMD_INIT_RESET
:
1530 if( goi
.argc
!= 0 ){
1531 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1534 e
= jtag_init_reset(context
);
1535 if( e
!= ERROR_OK
){
1536 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1540 case JTAG_CMD_NEWTAP
:
1541 return jim_newtap_cmd( &goi
);
1543 case JTAG_CMD_TAPISENABLED
:
1544 case JTAG_CMD_TAPENABLE
:
1545 case JTAG_CMD_TAPDISABLE
:
1546 if( goi
.argc
!= 1 ){
1547 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1553 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1558 case JTAG_CMD_TAPISENABLED
:
1561 case JTAG_CMD_TAPENABLE
:
1562 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1566 case JTAG_CMD_TAPDISABLE
:
1567 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1572 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1579 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1586 Jim_GetOpt_Obj(&goi
, &o
);
1587 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1592 goi
.isconfigure
= 0;
1593 return jtag_tap_configure_cmd( &goi
, t
);
1597 case JTAG_CMD_CONFIGURE
:
1599 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1606 Jim_GetOpt_Obj(&goi
, &o
);
1607 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1612 goi
.isconfigure
= 1;
1613 return jtag_tap_configure_cmd( &goi
, t
);
1620 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1622 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1624 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1625 COMMAND_CONFIG
, "try to configure interface");
1626 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1627 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1628 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1629 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1630 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1631 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1632 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1633 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1635 "[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]");
1636 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1637 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1638 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1639 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1641 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1642 COMMAND_EXEC
, "print current scan chain configuration");
1644 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1645 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1646 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1647 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1648 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1649 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1650 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1651 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1653 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1654 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1655 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1656 COMMAND_ANY
, "verify value capture <enable|disable>");
1657 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1658 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1662 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1667 if (!jtag_interface
)
1669 /* nothing was previously specified by "interface" command */
1670 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1671 return ERROR_JTAG_INVALID_INTERFACE
;
1675 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1679 if (jtag_interface
->init() != ERROR_OK
)
1680 return ERROR_JTAG_INIT_FAILED
;
1682 jtag
= jtag_interface
;
1686 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1691 LOG_DEBUG("Init JTAG chain");
1693 tap
= jtag_tap_next_enabled(NULL
);
1695 LOG_ERROR("There are no enabled taps?");
1696 return ERROR_JTAG_INIT_FAILED
;
1700 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1703 /* examine chain first, as this could discover the real chain layout */
1704 if (jtag_examine_chain() != ERROR_OK
)
1706 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1709 if (jtag_validate_chain() != ERROR_OK
)
1711 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1717 int jtag_interface_quit(void)
1719 if (!jtag
|| !jtag
->quit
)
1722 // close the JTAG interface
1723 int result
= jtag
->quit();
1724 if (ERROR_OK
!= result
)
1725 LOG_ERROR("failed: %d", result
);
1731 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1735 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1738 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1740 /* Reset can happen after a power cycle.
1742 * Ideally we would only assert TRST or run RESET before the target reset.
1744 * However w/srst_pulls_trst, trst is asserted together with the target
1745 * reset whether we want it or not.
1747 * NB! Some targets have JTAG circuitry disabled until a
1748 * trst & srst has been asserted.
1750 * NB! here we assume nsrst/ntrst delay are sufficient!
1752 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1755 jtag_add_reset(1, 0); /* RESET or TRST */
1756 if (jtag_reset_config
& RESET_HAS_SRST
)
1758 jtag_add_reset(1, 1);
1759 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1760 jtag_add_reset(0, 1);
1762 jtag_add_reset(0, 0);
1763 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1766 /* Check that we can communication on the JTAG chain + eventually we want to
1767 * be able to perform enumeration only after OpenOCD has started
1768 * telnet and GDB server
1770 * That would allow users to more easily perform any magic they need to before
1773 return jtag_init_inner(cmd_ctx
);
1776 int jtag_init(struct command_context_s
*cmd_ctx
)
1779 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1781 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1785 return jtag_init_reset(cmd_ctx
);
1788 void jtag_set_speed_khz(unsigned khz
)
1792 unsigned jtag_get_speed_khz(void)
1797 static int default_khz(int khz
, int *jtag_speed
)
1799 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1803 static int default_speed_div(int speed
, int *khz
)
1805 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1809 static int default_power_dropout(int *dropout
)
1811 *dropout
=0; /* by default we can't detect power dropout */
1815 static int default_srst_asserted(int *srst_asserted
)
1817 *srst_asserted
=0; /* by default we can't detect srst asserted */
1821 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1826 /* check whether the interface is already configured */
1829 LOG_WARNING("Interface already configured, ignoring");
1833 /* interface name is a mandatory argument */
1834 if (argc
< 1 || args
[0][0] == '\0')
1836 return ERROR_COMMAND_SYNTAX_ERROR
;
1839 for (i
=0; jtag_interfaces
[i
]; i
++)
1841 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1843 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1848 jtag_interface
= jtag_interfaces
[i
];
1850 if (jtag_interface
->khz
== NULL
)
1852 jtag_interface
->khz
= default_khz
;
1854 if (jtag_interface
->speed_div
== NULL
)
1856 jtag_interface
->speed_div
= default_speed_div
;
1858 if (jtag_interface
->power_dropout
== NULL
)
1860 jtag_interface
->power_dropout
= default_power_dropout
;
1862 if (jtag_interface
->srst_asserted
== NULL
)
1864 jtag_interface
->srst_asserted
= default_srst_asserted
;
1871 /* no valid interface was found (i.e. the configuration option,
1872 * didn't match one of the compiled-in interfaces
1874 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1875 LOG_ERROR("compiled-in jtag interfaces:");
1876 for (i
= 0; jtag_interfaces
[i
]; i
++)
1878 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1881 return ERROR_JTAG_INVALID_INTERFACE
;
1884 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1888 Jim_Obj
*newargs
[ 10 ];
1891 * argv[-1] = command
1892 * argv[ 0] = ir length
1893 * argv[ 1] = ir capture
1894 * argv[ 2] = ir mask
1895 * argv[ 3] = not actually used by anything but in the docs
1899 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1902 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1903 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1907 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1908 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1909 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1910 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1912 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1913 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1914 sprintf( buf
, "chip%d", jtag_tap_count() );
1915 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1916 sprintf( buf
, "tap%d", jtag_tap_count() );
1917 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1918 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1919 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1920 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1921 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1922 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1923 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1925 command_print( cmd_ctx
, "NEW COMMAND:");
1926 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1927 Jim_GetString( newargs
[0], NULL
),
1928 Jim_GetString( newargs
[1], NULL
),
1929 Jim_GetString( newargs
[2], NULL
),
1930 Jim_GetString( newargs
[3], NULL
),
1931 Jim_GetString( newargs
[4], NULL
),
1932 Jim_GetString( newargs
[5], NULL
),
1933 Jim_GetString( newargs
[6], NULL
),
1934 Jim_GetString( newargs
[7], NULL
),
1935 Jim_GetString( newargs
[8], NULL
),
1936 Jim_GetString( newargs
[9], NULL
) );
1938 e
= jim_jtag_command( interp
, 10, newargs
);
1940 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1945 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1949 tap
= jtag_all_taps();
1950 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1951 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1954 u32 expected
, expected_mask
, cur_instr
, ii
;
1955 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1956 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1957 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1959 command_print(cmd_ctx
,
1960 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1961 tap
->abs_chain_position
,
1963 tap
->enabled
? 'Y' : 'n',
1965 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1971 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1972 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1973 tap
->expected_ids
[ii
]);
1976 tap
= tap
->next_tap
;
1982 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1988 return ERROR_COMMAND_SYNTAX_ERROR
;
1990 /* Original versions cared about the order of these tokens:
1991 * reset_config signals [combination [trst_type [srst_type]]]
1992 * They also clobbered the previous configuration even on error.
1994 * Here we don't care about the order, and only change values
1995 * which have been explicitly specified.
1997 for (; argc
; argc
--, args
++) {
2002 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2003 if (strcmp(*args
, "none") == 0)
2005 else if (strcmp(*args
, "trst_only") == 0)
2006 tmp
= RESET_HAS_TRST
;
2007 else if (strcmp(*args
, "srst_only") == 0)
2008 tmp
= RESET_HAS_SRST
;
2009 else if (strcmp(*args
, "trst_and_srst") == 0)
2010 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2014 LOG_ERROR("extra reset_config %s spec (%s)",
2016 return ERROR_INVALID_ARGUMENTS
;
2021 /* combination (options for broken wiring) */
2022 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2023 if (strcmp(*args
, "separate") == 0)
2024 /* separate reset lines - default */;
2025 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2026 tmp
|= RESET_SRST_PULLS_TRST
;
2027 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2028 tmp
|= RESET_TRST_PULLS_SRST
;
2029 else if (strcmp(*args
, "combined") == 0)
2030 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2034 LOG_ERROR("extra reset_config %s spec (%s)",
2035 "combination", *args
);
2036 return ERROR_INVALID_ARGUMENTS
;
2041 /* trst_type (NOP without HAS_TRST) */
2042 m
= RESET_TRST_OPEN_DRAIN
;
2043 if (strcmp(*args
, "trst_open_drain") == 0)
2044 tmp
|= RESET_TRST_OPEN_DRAIN
;
2045 else if (strcmp(*args
, "trst_push_pull") == 0)
2046 /* push/pull from adapter - default */;
2050 LOG_ERROR("extra reset_config %s spec (%s)",
2051 "trst_type", *args
);
2052 return ERROR_INVALID_ARGUMENTS
;
2057 /* srst_type (NOP without HAS_SRST) */
2058 m
|= RESET_SRST_PUSH_PULL
;
2059 if (strcmp(*args
, "srst_push_pull") == 0)
2060 tmp
|= RESET_SRST_PUSH_PULL
;
2061 else if (strcmp(*args
, "srst_open_drain") == 0)
2062 /* open drain from adapter - default */;
2066 LOG_ERROR("extra reset_config %s spec (%s)",
2067 "srst_type", *args
);
2068 return ERROR_INVALID_ARGUMENTS
;
2073 /* caller provided nonsense; fail */
2074 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2075 return ERROR_INVALID_ARGUMENTS
;
2078 /* Remember the bits which were specified (mask)
2079 * and their new values (new_cfg).
2085 /* clear previous values of those bits, save new values */
2086 jtag_reset_config
&= ~mask
;
2087 jtag_reset_config
|= new_cfg
;
2092 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2093 char *cmd
, char **args
, int argc
)
2096 return ERROR_COMMAND_SYNTAX_ERROR
;
2098 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2099 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2103 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2104 char *cmd
, char **args
, int argc
)
2107 return ERROR_COMMAND_SYNTAX_ERROR
;
2109 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2110 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2114 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2116 int retval
= ERROR_OK
;
2119 return ERROR_COMMAND_SYNTAX_ERROR
;
2122 LOG_DEBUG("handle jtag speed");
2125 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2127 /* this command can be called during CONFIG,
2128 * in which case jtag isn't initialized */
2130 retval
= jtag
->speed(cur_speed
);
2132 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2137 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2140 return ERROR_COMMAND_SYNTAX_ERROR
;
2142 int retval
= ERROR_OK
;
2146 LOG_DEBUG("handle jtag khz");
2148 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2151 LOG_DEBUG("have interface set up");
2153 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2154 if (ERROR_OK
!= retval
)
2156 jtag_set_speed_khz(0);
2159 cur_speed
= jtag_speed
= speed_div1
;
2161 retval
= jtag
->speed(cur_speed
);
2167 cur_speed
= jtag_get_speed_khz();
2170 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2171 if (ERROR_OK
!= retval
)
2176 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2178 command_print(cmd_ctx
, "RCLK - adaptive");
2183 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
2184 char *cmd
, char **args
, int argc
)
2187 return ERROR_COMMAND_SYNTAX_ERROR
;
2190 if (args
[0][0] == '1')
2192 else if (args
[0][0] == '0')
2195 return ERROR_COMMAND_SYNTAX_ERROR
;
2198 if (args
[1][0] == '1')
2200 else if (args
[1][0] == '0')
2203 return ERROR_COMMAND_SYNTAX_ERROR
;
2205 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2206 return ERROR_JTAG_INIT_FAILED
;
2208 jtag_add_reset(trst
, srst
);
2209 jtag_execute_queue();
2214 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
2215 char *cmd
, char **args
, int argc
)
2218 return ERROR_COMMAND_SYNTAX_ERROR
;
2220 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2221 jtag_execute_queue();
2227 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2228 * should be stable ... and *NOT* a shift state, otherwise free-running
2229 * jtag clocks could change the values latched by the update state.
2231 static bool scan_is_safe(tap_state_t state
)
2246 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2249 scan_field_t
*fields
;
2251 tap_state_t endstate
;
2253 if ((argc
< 2) || (argc
% 2))
2255 return ERROR_COMMAND_SYNTAX_ERROR
;
2258 /* optional "-endstate" "statename" at the end of the arguments,
2259 * so that e.g. IRPAUSE can let us load the data register before
2260 * entering RUN/IDLE to execute the instruction we load here.
2262 endstate
= TAP_IDLE
;
2265 /* have at least one pair of numbers. */
2266 /* is last pair the magic text? */
2267 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2270 cpA
= args
[ argc
-1 ];
2271 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2272 cpS
= tap_state_name( endstate
);
2273 if( 0 == strcmp( cpA
, cpS
) ){
2277 if( endstate
>= TAP_NUM_STATES
){
2278 return ERROR_COMMAND_SYNTAX_ERROR
;
2280 if (!scan_is_safe(endstate
))
2281 LOG_WARNING("irscan with unsafe "
2282 "endstate \"%s\"", cpA
);
2283 /* found - remove the last 2 args */
2289 int num_fields
= argc
/ 2;
2291 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2293 for (i
= 0; i
< num_fields
; i
++)
2295 tap
= jtag_tap_by_string( args
[i
*2] );
2298 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2301 int field_size
= tap
->ir_length
;
2302 fields
[i
].tap
= tap
;
2303 fields
[i
].num_bits
= field_size
;
2304 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2305 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2306 fields
[i
].in_value
= NULL
;
2309 /* did we have an endstate? */
2310 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2312 int retval
=jtag_execute_queue();
2314 for (i
= 0; i
< num_fields
; i
++)
2315 free(fields
[i
].out_value
);
2322 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2325 scan_field_t
*fields
;
2327 int field_count
= 0;
2330 tap_state_t endstate
;
2333 * args[2] = num_bits
2334 * args[3] = hex string
2335 * ... repeat num bits and hex string ...
2338 * args[N-2] = "-endstate"
2339 * args[N-1] = statename
2341 if ((argc
< 4) || ((argc
% 2)!=0))
2343 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2347 endstate
= TAP_IDLE
;
2349 /* validate arguments as numbers */
2351 for (i
= 2; i
< argc
; i
+=2)
2356 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2357 /* If valid - try next arg */
2362 /* Not valid.. are we at the end? */
2363 if ( ((i
+2) != argc
) ){
2364 /* nope, then error */
2368 /* it could be: "-endstate FOO"
2369 * e.g. DRPAUSE so we can issue more instructions
2370 * before entering RUN/IDLE and executing them.
2373 /* get arg as a string. */
2374 cp
= Jim_GetString( args
[i
], NULL
);
2375 /* is it the magic? */
2376 if( 0 == strcmp( "-endstate", cp
) ){
2377 /* is the statename valid? */
2378 cp
= Jim_GetString( args
[i
+1], NULL
);
2380 /* see if it is a valid state name */
2381 endstate
= tap_state_by_name(cp
);
2383 /* update the error message */
2384 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2386 if (!scan_is_safe(endstate
))
2387 LOG_WARNING("drscan with unsafe "
2388 "endstate \"%s\"", cp
);
2390 /* valid - so clear the error */
2392 /* and remove the last 2 args */
2397 /* Still an error? */
2399 return e
; /* too bad */
2401 } /* validate args */
2403 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2408 num_fields
=(argc
-2)/2;
2409 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2410 for (i
= 2; i
< argc
; i
+=2)
2416 Jim_GetLong(interp
, args
[i
], &bits
);
2417 str
= Jim_GetString(args
[i
+1], &len
);
2419 fields
[field_count
].tap
= tap
;
2420 fields
[field_count
].num_bits
= bits
;
2421 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2422 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2423 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2427 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2429 retval
= jtag_execute_queue();
2430 if (retval
!= ERROR_OK
)
2432 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2437 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2438 for (i
= 2; i
< argc
; i
+=2)
2443 Jim_GetLong(interp
, args
[i
], &bits
);
2444 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2445 free(fields
[field_count
].out_value
);
2447 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2452 Jim_SetResult(interp
, list
);
2460 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2462 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2468 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2472 if (strcmp(args
[0], "enable") == 0)
2474 jtag_verify_capture_ir
= 1;
2476 else if (strcmp(args
[0], "disable") == 0)
2478 jtag_verify_capture_ir
= 0;
2481 return ERROR_COMMAND_SYNTAX_ERROR
;
2483 } else if (argc
!= 0)
2485 return ERROR_COMMAND_SYNTAX_ERROR
;
2488 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2493 void jtag_set_verify(bool enable
)
2495 jtag_verify
= enable
;
2498 bool jtag_will_verify()
2503 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2506 return ERROR_COMMAND_SYNTAX_ERROR
;
2510 if (strcmp(args
[0], "enable") == 0)
2511 jtag_set_verify(true);
2512 else if (strcmp(args
[0], "disable") == 0)
2513 jtag_set_verify(false);
2515 return ERROR_COMMAND_SYNTAX_ERROR
;
2518 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2519 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2525 int jtag_power_dropout(int *dropout
)
2527 return jtag
->power_dropout(dropout
);
2530 int jtag_srst_asserted(int *srst_asserted
)
2532 return jtag
->srst_asserted(srst_asserted
);
2535 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2537 jtag_tap_event_action_t
* jteap
;
2540 jteap
= tap
->event_action
;
2544 if (jteap
->event
== e
) {
2546 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2549 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2550 Jim_GetString(jteap
->body
, NULL
) );
2551 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2552 Jim_PrintErrorMessage(interp
);
2556 jteap
= jteap
->next
;
2560 LOG_DEBUG( "event %d %s - no action",
2562 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2566 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2569 return ERROR_COMMAND_SYNTAX_ERROR
;
2574 if (strcmp(args
[0], "short") == 0)
2575 use_new_table
= true;
2576 else if (strcmp(args
[0], "long") == 0)
2577 use_new_table
= false;
2579 return ERROR_COMMAND_SYNTAX_ERROR
;
2581 tap_use_new_tms_table(use_new_table
);
2584 command_print(cmd_ctx
, "tms sequence is %s",
2585 tap_uses_new_tms_table() ? "short": "long");
2591 * Function jtag_add_statemove
2592 * moves from the current state to the goal \a state. This needs
2593 * to be handled according to the xsvf spec, see the XSTATE command
2596 int jtag_add_statemove(tap_state_t goal_state
)
2598 int retval
= ERROR_OK
;
2600 tap_state_t moves
[8];
2601 tap_state_t cur_state
= cmd_queue_cur_state
;
2606 LOG_DEBUG( "cur_state=%s goal_state=%s",
2607 tap_state_name(cur_state
),
2608 tap_state_name(goal_state
) );
2611 /* From the XSVF spec, pertaining to XSTATE:
2613 For special states known as stable states (Test-Logic-Reset,
2614 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2615 predefined TAP state paths when the starting state is a stable state and
2616 when the XSTATE specifies a new stable state (see the STATE command in
2617 the [Ref 5] for the TAP state paths between stable states). For
2618 non-stable states, XSTATE should specify a state that is only one TAP
2619 state transition distance from the current TAP state to avoid undefined
2620 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2621 transition the TAP through a specific state path.
2624 if (goal_state
==cur_state
)
2625 ; /* nothing to do */
2627 else if( goal_state
==TAP_RESET
)
2632 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2634 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2635 spec, then this code is not fully conformant to the xsvf spec. This
2636 puts a burden on tap_get_tms_path() function from the xsvf spec.
2637 If in doubt, you should confirm that that burden is being met.
2640 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2641 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2643 assert( (unsigned) tms_count
< DIM(moves
) );
2645 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2647 bool bit
= tms_bits
& 1;
2649 cur_state
= tap_state_transition(cur_state
, bit
);
2650 moves
[i
] = cur_state
;
2653 jtag_add_pathmove(tms_count
, moves
);
2656 /* else state must be immediately reachable in one clock cycle, and does not
2657 need to be a stable state.
2659 else if( tap_state_transition(cur_state
, true) == goal_state
2660 || tap_state_transition(cur_state
, false) == goal_state
)
2662 /* move a single state */
2663 moves
[0] = goal_state
;
2664 jtag_add_pathmove( 1, moves
);
2669 retval
= ERROR_FAIL
;
2675 void jtag_set_nsrst_delay(unsigned delay
)
2677 jtag_nsrst_delay
= delay
;
2679 unsigned jtag_get_nsrst_delay(void)
2681 return jtag_nsrst_delay
;
2683 void jtag_set_ntrst_delay(unsigned delay
)
2685 jtag_ntrst_delay
= delay
;
2687 unsigned jtag_get_ntrst_delay(void)
2689 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)