1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
17 * This program is distributed in the hope that it will be useful, *
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
20 * GNU General Public License for more details. *
22 * You should have received a copy of the GNU General Public License *
23 * along with this program; if not, write to the *
24 * Free Software Foundation, Inc., *
25 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
26 ***************************************************************************/
32 #include "minidriver.h"
33 #include "interface.h"
40 /// The number of JTAG queue flushes (for profiling and debugging purposes).
41 static int jtag_flush_queue_count
;
43 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
44 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
);
46 /* note that this is not marked as static as it must be available from outside jtag.c for those
47 that implement the jtag_xxx() minidriver layer
49 int jtag_error
=ERROR_OK
;
51 char* jtag_event_strings
[] =
53 "JTAG controller reset (RESET or TRST)"
56 const Jim_Nvp nvp_jtag_tap_event
[] = {
57 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
58 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
60 { .name
= NULL
, .value
= -1 }
67 * List all TAPs that have been created.
69 static jtag_tap_t
*__jtag_all_taps
= NULL
;
71 * The number of TAPs in the __jtag_all_taps list, used to track the
72 * assigned chain position to new TAPs
74 static int jtag_num_taps
= 0;
76 enum reset_types jtag_reset_config
= RESET_NONE
;
77 tap_state_t cmd_queue_end_state
= TAP_RESET
;
78 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
80 int jtag_verify_capture_ir
= 1;
83 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
84 static int jtag_nsrst_delay
= 0; /* default to no nSRST delay */
85 static int jtag_ntrst_delay
= 0; /* default to no nTRST delay */
87 /* callbacks to inform high-level handlers about JTAG state changes */
88 jtag_event_callback_t
*jtag_event_callbacks
;
91 static int speed_khz
= 0;
92 /* flag if the kHz speed was defined */
93 static bool hasKHz
= false;
95 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
98 #if BUILD_ECOSBOARD == 1
99 extern jtag_interface_t zy1000_interface
;
100 #elif defined(BUILD_MINIDRIVER_DUMMY)
101 extern jtag_interface_t minidummy_interface
;
102 #else // standard drivers
103 #if BUILD_PARPORT == 1
104 extern jtag_interface_t parport_interface
;
108 extern jtag_interface_t dummy_interface
;
111 #if BUILD_FT2232_FTD2XX == 1
112 extern jtag_interface_t ft2232_interface
;
115 #if BUILD_FT2232_LIBFTDI == 1
116 extern jtag_interface_t ft2232_interface
;
119 #if BUILD_AMTJTAGACCEL == 1
120 extern jtag_interface_t amt_jtagaccel_interface
;
123 #if BUILD_EP93XX == 1
124 extern jtag_interface_t ep93xx_interface
;
127 #if BUILD_AT91RM9200 == 1
128 extern jtag_interface_t at91rm9200_interface
;
131 #if BUILD_GW16012 == 1
132 extern jtag_interface_t gw16012_interface
;
135 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
136 extern jtag_interface_t presto_interface
;
139 #if BUILD_USBPROG == 1
140 extern jtag_interface_t usbprog_interface
;
144 extern jtag_interface_t jlink_interface
;
147 #if BUILD_VSLLINK == 1
148 extern jtag_interface_t vsllink_interface
;
152 extern jtag_interface_t rlink_interface
;
155 #if BUILD_ARMJTAGEW == 1
156 extern jtag_interface_t armjtagew_interface
;
158 #endif // standard drivers
161 * The list of built-in JTAG interfaces, containing entries for those
162 * drivers that were enabled by the @c configure script.
164 * The list should be defined to contain either one minidriver interface
165 * or some number of standard driver interfaces, never both.
167 jtag_interface_t
*jtag_interfaces
[] = {
168 #if BUILD_ECOSBOARD == 1
170 #elif defined(BUILD_MINIDRIVER_DUMMY)
171 &minidummy_interface
,
172 #else // standard drivers
173 #if BUILD_PARPORT == 1
179 #if BUILD_FT2232_FTD2XX == 1
182 #if BUILD_FT2232_LIBFTDI == 1
185 #if BUILD_AMTJTAGACCEL == 1
186 &amt_jtagaccel_interface
,
188 #if BUILD_EP93XX == 1
191 #if BUILD_AT91RM9200 == 1
192 &at91rm9200_interface
,
194 #if BUILD_GW16012 == 1
197 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
200 #if BUILD_USBPROG == 1
206 #if BUILD_VSLLINK == 1
212 #if BUILD_ARMJTAGEW == 1
213 &armjtagew_interface
,
215 #endif // standard drivers
219 struct jtag_interface_s
*jtag
= NULL
;
222 static jtag_interface_t
*jtag_interface
= NULL
;
226 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
227 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
228 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
229 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
230 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
231 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
232 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
234 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
236 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
237 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
238 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
239 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
240 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
242 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
243 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
244 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
246 jtag_tap_t
*jtag_all_taps(void)
248 return __jtag_all_taps
;
251 int jtag_tap_count(void)
253 return jtag_num_taps
;
256 unsigned jtag_tap_count_enabled(void)
272 /// Append a new TAP to the chain of all taps.
273 static void jtag_tap_add(struct jtag_tap_s
*t
)
275 t
->abs_chain_position
= jtag_num_taps
++;
277 jtag_tap_t
**tap
= &__jtag_all_taps
;
279 tap
= &(*tap
)->next_tap
;
283 jtag_tap_t
*jtag_tap_by_string( const char *s
)
291 if( 0 == strcmp( t
->dotted_name
, s
) ){
297 /* backup plan is by number */
299 /* ok - is "s" a number? */
301 n
= strtol( s
, &cp
, 0 );
302 if( (s
!= cp
) && (*cp
== 0) ){
304 t
= jtag_tap_by_abs_position(n
);
310 jtag_tap_t
* jtag_tap_by_jim_obj( Jim_Interp
*interp
, Jim_Obj
*o
)
315 cp
= Jim_GetString( o
, NULL
);
320 t
= jtag_tap_by_string( cp
);
323 Jim_SetResult_sprintf(interp
,"Tap: %s is unknown", cp
);
328 /* returns a pointer to the n-th device in the scan chain */
329 jtag_tap_t
* jtag_tap_by_abs_position( int n
)
337 while( t
&& (n
> 0)) {
344 const char *jtag_tap_name(const jtag_tap_t
*tap
)
346 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
350 int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
)
352 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
354 if (callback
== NULL
)
356 return ERROR_INVALID_ARGUMENTS
;
361 while ((*callbacks_p
)->next
)
362 callbacks_p
= &((*callbacks_p
)->next
);
363 callbacks_p
= &((*callbacks_p
)->next
);
366 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
367 (*callbacks_p
)->callback
= callback
;
368 (*callbacks_p
)->priv
= priv
;
369 (*callbacks_p
)->next
= NULL
;
374 int jtag_unregister_event_callback(int (*callback
)(enum jtag_event event
, void *priv
))
376 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
378 if (callback
== NULL
)
380 return ERROR_INVALID_ARGUMENTS
;
385 jtag_event_callback_t
**next
= &((*callbacks_p
)->next
);
386 if ((*callbacks_p
)->callback
== callback
)
389 *callbacks_p
= *next
;
397 int jtag_call_event_callbacks(enum jtag_event event
)
399 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
401 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
405 callback
->callback(event
, callback
->priv
);
406 callback
= callback
->next
;
412 static void jtag_checks(void)
414 assert(jtag_trst
== 0);
417 static void jtag_prelude(tap_state_t state
)
421 assert(state
!=TAP_INVALID
);
423 cmd_queue_cur_state
= state
;
426 void jtag_alloc_in_value32(scan_field_t
*field
)
428 interface_jtag_alloc_in_value32(field
);
431 void jtag_add_ir_scan_noverify(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
436 retval
=interface_jtag_add_ir_scan(in_num_fields
, in_fields
, state
);
437 if (retval
!=ERROR_OK
)
444 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
446 * If the input field list contains an instruction value for a TAP then that is used
447 * otherwise the TAP is set to bypass.
449 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
452 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
454 if (jtag_verify
&&jtag_verify_capture_ir
)
456 /* 8 x 32 bit id's is enough for all invocations */
458 for (int j
= 0; j
< in_num_fields
; j
++)
460 /* if we are to run a verification of the ir scan, we need to get the input back.
461 * We may have to allocate space if the caller didn't ask for the input back.
463 in_fields
[j
].check_value
=in_fields
[j
].tap
->expected
;
464 in_fields
[j
].check_mask
=in_fields
[j
].tap
->expected_mask
;
466 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
469 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
474 * Duplicate the scan fields passed into the function into an IR SCAN command
476 * This function assumes that the caller handles extra fields for bypassed TAPs
479 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
485 retval
=interface_jtag_add_plain_ir_scan(in_num_fields
, in_fields
, state
);
486 if (retval
!=ERROR_OK
)
490 void jtag_add_callback(jtag_callback1_t f
, u8
*in
)
492 interface_jtag_add_callback(f
, in
);
495 void jtag_add_callback4(jtag_callback_t f
, u8
*in
,
496 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
497 jtag_callback_data_t data3
)
499 interface_jtag_add_callback4(f
, in
, data1
, data2
, data3
);
502 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
);
504 static int jtag_check_value_mask_callback(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
506 return jtag_check_value_inner(in
, (u8
*)data1
, (u8
*)data2
, (int)data3
);
509 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
510 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
512 for (int i
= 0; i
< in_num_fields
; i
++)
514 struct scan_field_s
*field
= &in_fields
[i
];
515 field
->allocated
= 0;
517 if (field
->check_value
|| field
->in_value
)
519 interface_jtag_add_scan_check_alloc(field
);
523 jtag_add_scan(in_num_fields
, in_fields
, state
);
525 for (int i
= 0; i
< in_num_fields
; i
++)
527 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
529 /* this is synchronous for a minidriver */
530 jtag_add_callback4(jtag_check_value_mask_callback
, in_fields
[i
].in_value
,
531 (jtag_callback_data_t
)in_fields
[i
].check_value
,
532 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
533 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
535 if (in_fields
[i
].allocated
)
537 free(in_fields
[i
].in_value
);
539 if (in_fields
[i
].modified
)
541 in_fields
[i
].in_value
= NULL
;
546 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
550 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
553 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
559 * Generate a DR SCAN using the fields passed to the function
561 * For not bypassed TAPs the function checks in_fields and uses fields specified there.
562 * For bypassed TAPs the function generates a dummy 1bit field.
564 * The bypass status of TAPs is set by jtag_add_ir_scan().
567 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
573 retval
=interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
574 if (retval
!=ERROR_OK
)
581 * Duplicate the scan fields passed into the function into a DR SCAN command
583 * This function assumes that the caller handles extra fields for bypassed TAPs
586 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
592 retval
=interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
593 if (retval
!=ERROR_OK
)
597 void jtag_add_dr_out(jtag_tap_t
* tap
,
598 int num_fields
, const int* num_bits
, const u32
* value
,
599 tap_state_t end_state
)
601 assert(end_state
!= TAP_INVALID
);
603 cmd_queue_cur_state
= end_state
;
605 interface_jtag_add_dr_out(tap
,
606 num_fields
, num_bits
, value
,
610 void jtag_add_tlr(void)
612 jtag_prelude(TAP_RESET
);
615 retval
=interface_jtag_add_tlr();
616 if (retval
!=ERROR_OK
)
619 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
622 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
624 tap_state_t cur_state
= cmd_queue_cur_state
;
628 /* the last state has to be a stable state */
629 if (!tap_is_state_stable(path
[num_states
- 1]))
631 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
635 for (i
=0; i
<num_states
; i
++)
637 if (path
[i
] == TAP_RESET
)
639 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
643 if ( tap_state_transition(cur_state
, true) != path
[i
]
644 && tap_state_transition(cur_state
, false) != path
[i
])
646 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[i
]));
654 retval
= interface_jtag_add_pathmove(num_states
, path
);
655 cmd_queue_cur_state
= path
[num_states
- 1];
656 if (retval
!=ERROR_OK
)
660 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
666 /* executed by sw or hw fifo */
667 retval
=interface_jtag_add_runtest(num_cycles
, state
);
668 if (retval
!=ERROR_OK
)
673 void jtag_add_clocks( int num_cycles
)
677 if( !tap_is_state_stable(cmd_queue_cur_state
) )
679 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
680 tap_state_name(cmd_queue_cur_state
) );
681 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
689 retval
= interface_jtag_add_clocks(num_cycles
);
690 if (retval
!= ERROR_OK
)
695 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
697 int trst_with_tlr
= 0;
700 /* FIX!!! there are *many* different cases here. A better
701 * approach is needed for legal combinations of transitions...
703 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
704 (jtag_reset_config
& RESET_HAS_TRST
)&&
705 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
707 if (((req_tlr_or_trst
&&!jtag_trst
)||
708 (!req_tlr_or_trst
&&jtag_trst
))&&
709 ((req_srst
&&!jtag_srst
)||
710 (!req_srst
&&jtag_srst
)))
712 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
713 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
717 /* Make sure that jtag_reset_config allows the requested reset */
718 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
719 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
721 LOG_ERROR("BUG: requested reset would assert trst");
722 jtag_error
=ERROR_FAIL
;
726 /* if TRST pulls SRST, we reset with TAP T-L-R */
727 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
732 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
734 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
735 jtag_error
=ERROR_FAIL
;
741 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
753 jtag_srst
= req_srst
;
755 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
756 if (retval
!=ERROR_OK
)
761 jtag_execute_queue();
765 LOG_DEBUG("SRST line asserted");
769 LOG_DEBUG("SRST line released");
770 if (jtag_nsrst_delay
)
771 jtag_add_sleep(jtag_nsrst_delay
* 1000);
776 LOG_DEBUG("JTAG reset with RESET instead of TRST");
777 jtag_set_end_state(TAP_RESET
);
784 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
785 * and inform possible listeners about this
787 LOG_DEBUG("TRST line asserted");
788 tap_set_state(TAP_RESET
);
789 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
793 if (jtag_ntrst_delay
)
794 jtag_add_sleep(jtag_ntrst_delay
* 1000);
798 tap_state_t
jtag_set_end_state(tap_state_t state
)
800 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
802 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
805 if (state
!=TAP_INVALID
)
806 cmd_queue_end_state
= state
;
807 return cmd_queue_end_state
;
810 tap_state_t
jtag_get_end_state(void)
812 return cmd_queue_end_state
;
815 void jtag_add_sleep(u32 us
)
817 keep_alive(); /* we might be running on a very slow JTAG clk */
818 int retval
=interface_jtag_add_sleep(us
);
819 if (retval
!=ERROR_OK
)
824 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
826 int retval
= ERROR_OK
;
828 int compare_failed
= 0;
831 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
833 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
836 /* An error handler could have caught the failing check
837 * only report a problem when there wasn't a handler, or if the handler
838 * acknowledged the error
841 LOG_WARNING("TAP %s:",
842 jtag_tap_name(field->tap));
846 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
847 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
851 char *in_check_mask_char
;
852 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
853 LOG_WARNING("value captured during scan didn't pass the requested check:");
854 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
855 captured_char
, in_check_value_char
, in_check_mask_char
);
856 free(in_check_mask_char
);
860 LOG_WARNING("value captured during scan didn't pass the requested check: captured: 0x%s check_value: 0x%s", captured_char
, in_check_value_char
);
864 free(in_check_value_char
);
866 retval
= ERROR_JTAG_QUEUE_FAILED
;
873 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
875 assert(field
->in_value
!= NULL
);
879 /* no checking to do */
883 jtag_execute_queue_noclear();
885 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
886 jtag_set_error(retval
);
891 int default_interface_jtag_execute_queue(void)
895 LOG_ERROR("No JTAG interface configured yet. "
896 "Issue 'init' command in startup scripts "
897 "before communicating with targets.");
901 return jtag
->execute_queue();
904 void jtag_execute_queue_noclear(void)
906 jtag_flush_queue_count
++;
907 jtag_set_error(interface_jtag_execute_queue());
910 int jtag_get_flush_queue_count(void)
912 return jtag_flush_queue_count
;
915 int jtag_execute_queue(void)
917 jtag_execute_queue_noclear();
918 return jtag_error_clear();
921 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
923 jtag_tap_t
*tap
= priv
;
927 if (event
== JTAG_TRST_ASSERTED
)
929 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
936 void jtag_sleep(u32 us
)
938 alive_sleep(us
/1000);
941 /// maximum number of JTAG devices expected in the chain
942 #define JTAG_MAX_CHAIN_SIZE 20
944 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
945 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
946 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
948 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
950 scan_field_t field
= {
952 .num_bits
= num_idcode
* 32,
953 .out_value
= idcode_buffer
,
954 .in_value
= idcode_buffer
,
957 // initialize to the end of chain ID value
958 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
959 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
961 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
962 return jtag_execute_queue();
965 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
970 for (unsigned i
= 0; i
< count
* 4; i
++)
972 zero_check
|= idcodes
[i
];
973 one_check
&= idcodes
[i
];
976 /* if there wasn't a single non-zero bit or if all bits were one,
977 * the scan is not valid */
978 if (zero_check
== 0x00 || one_check
== 0xff)
980 LOG_ERROR("JTAG communication failure: check connection, "
981 "JTAG interface, target power etc.");
987 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
988 const char *name
, u32 idcode
)
990 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
991 "JTAG tap: %s %16.16s: 0x%08x "
992 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
994 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
997 static bool jtag_idcode_is_final(u32 idcode
)
999 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
1003 * This helper checks that remaining bits in the examined chain data are
1004 * all as expected, but a single JTAG device requires only 64 bits to be
1005 * read back correctly. This can help identify and diagnose problems
1006 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1008 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
1010 bool triggered
= false;
1011 for ( ; count
< max
- 31; count
+= 32)
1013 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
1014 // do not trigger the warning if the data looks good
1015 if (!triggered
&& jtag_idcode_is_final(idcode
))
1017 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1023 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1025 if (0 == tap
->expected_ids_cnt
)
1027 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1029 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1030 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1035 /* Loop over the expected identification codes and test for a match */
1037 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1039 if (tap
->idcode
== tap
->expected_ids
[ii
])
1043 /* If none of the expected ids matched, log an error */
1044 if (ii
!= tap
->expected_ids_cnt
)
1046 LOG_INFO("JTAG Tap/device matched");
1049 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1050 tap
->dotted_name
, tap
->idcode
);
1051 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1054 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1055 ii
+ 1, tap
->expected_ids_cnt
);
1056 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1057 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1062 /* Try to examine chain layout according to IEEE 1149.1 §12
1064 static int jtag_examine_chain(void)
1066 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1067 unsigned device_count
= 0;
1069 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1071 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1072 return ERROR_JTAG_INIT_FAILED
;
1074 /* point at the 1st tap */
1075 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1078 LOG_ERROR("JTAG: No taps enabled?");
1079 return ERROR_JTAG_INIT_FAILED
;
1082 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1084 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1085 if ((idcode
& 1) == 0)
1087 /* LSB must not be 0, this indicates a device in bypass */
1088 LOG_WARNING("Tap/Device does not have IDCODE");
1096 * End of chain (invalid manufacturer ID) some devices, such
1097 * as AVR will output all 1's instead of TDI input value at
1100 if (jtag_idcode_is_final(idcode
))
1102 jtag_examine_chain_end(idcode_buffer
,
1103 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1107 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1108 tap
? tap
->dotted_name
: "(not-named)",
1117 tap
->idcode
= idcode
;
1119 // ensure the TAP ID does matches what was expected
1120 if (!jtag_examine_chain_match_tap(tap
))
1121 return ERROR_JTAG_INIT_FAILED
;
1123 tap
= jtag_tap_next_enabled(tap
);
1126 /* see if number of discovered devices matches configuration */
1127 if (device_count
!= jtag_tap_count_enabled())
1129 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1130 "does not match (enabled) configuration (%i), total taps: %d",
1131 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1132 LOG_ERROR("check the config file and ensure proper JTAG communication"
1133 " (connections, speed, ...)");
1134 return ERROR_JTAG_INIT_FAILED
;
1140 static int jtag_validate_chain(void)
1143 int total_ir_length
= 0;
1149 total_ir_length
= 0;
1151 tap
= jtag_tap_next_enabled(tap
);
1155 total_ir_length
+= tap
->ir_length
;
1158 total_ir_length
+= 2;
1159 ir_test
= malloc(CEIL(total_ir_length
, 8));
1160 buf_set_ones(ir_test
, total_ir_length
);
1163 field
.num_bits
= total_ir_length
;
1164 field
.out_value
= ir_test
;
1165 field
.in_value
= ir_test
;
1168 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1169 jtag_execute_queue();
1175 tap
= jtag_tap_next_enabled(tap
);
1180 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1183 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1184 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
);
1187 return ERROR_JTAG_INIT_FAILED
;
1189 chain_pos
+= tap
->ir_length
;
1192 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1195 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1196 LOG_ERROR("Could not validate end of JTAG scan chain, IR mismatch, scan returned 0x%s. pos=%d expected 0x3 got %0x", cbuf
, chain_pos
, val
);
1199 return ERROR_JTAG_INIT_FAILED
;
1207 enum jtag_tap_cfg_param
{
1211 static Jim_Nvp nvp_config_opts
[] = {
1212 { .name
= "-event", .value
= JCFG_EVENT
},
1214 { .name
= NULL
, .value
= -1 }
1217 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1223 /* parse config or cget options */
1224 while (goi
->argc
> 0) {
1225 Jim_SetEmptyResult (goi
->interp
);
1227 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1229 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1235 if (goi
->argc
== 0) {
1236 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1240 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1242 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1246 if (goi
->isconfigure
) {
1247 if (goi
->argc
!= 1) {
1248 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1252 if (goi
->argc
!= 0) {
1253 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1259 jtag_tap_event_action_t
*jteap
;
1261 jteap
= tap
->event_action
;
1262 /* replace existing? */
1264 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1267 jteap
= jteap
->next
;
1270 if (goi
->isconfigure
) {
1271 if (jteap
== NULL
) {
1273 jteap
= calloc(1, sizeof (*jteap
));
1275 jteap
->event
= n
->value
;
1276 Jim_GetOpt_Obj( goi
, &o
);
1278 Jim_DecrRefCount(interp
, jteap
->body
);
1280 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1281 Jim_IncrRefCount(jteap
->body
);
1283 /* add to head of event list */
1284 jteap
->next
= tap
->event_action
;
1285 tap
->event_action
= jteap
;
1286 Jim_SetEmptyResult(goi
->interp
);
1289 if (jteap
== NULL
) {
1290 Jim_SetEmptyResult(goi
->interp
);
1292 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1299 } /* while (goi->argc) */
1305 static void jtag_tap_init(jtag_tap_t
*tap
)
1307 assert(0 != tap
->ir_length
);
1309 tap
->expected
= malloc(tap
->ir_length
);
1310 tap
->expected_mask
= malloc(tap
->ir_length
);
1311 tap
->cur_instr
= malloc(tap
->ir_length
);
1313 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1314 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1315 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1317 // place TAP in bypass mode
1319 // register the reset callback for the TAP
1320 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1322 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1323 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1324 tap
->abs_chain_position
, tap
->ir_length
,
1325 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1329 static void jtag_tap_free(jtag_tap_t
*tap
)
1331 /// @todo is anything missing? no memory leaks please
1332 free((void *)tap
->expected_ids
);
1333 free((void *)tap
->chip
);
1334 free((void *)tap
->tapname
);
1335 free((void *)tap
->dotted_name
);
1339 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1348 const Jim_Nvp opts
[] = {
1349 #define NTAP_OPT_IRLEN 0
1350 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1351 #define NTAP_OPT_IRMASK 1
1352 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1353 #define NTAP_OPT_IRCAPTURE 2
1354 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1355 #define NTAP_OPT_ENABLED 3
1356 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1357 #define NTAP_OPT_DISABLED 4
1358 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1359 #define NTAP_OPT_EXPECTED_ID 5
1360 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1361 { .name
= NULL
, .value
= -1 },
1364 pTap
= malloc( sizeof(jtag_tap_t
) );
1365 memset( pTap
, 0, sizeof(*pTap
) );
1367 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1371 * we expect CHIP + TAP + OPTIONS
1373 if( goi
->argc
< 3 ){
1374 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1377 Jim_GetOpt_String( goi
, &cp
, NULL
);
1378 pTap
->chip
= strdup(cp
);
1380 Jim_GetOpt_String( goi
, &cp
, NULL
);
1381 pTap
->tapname
= strdup(cp
);
1383 /* name + dot + name + null */
1384 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1386 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1387 pTap
->dotted_name
= cp
;
1389 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1390 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1392 /* default is enabled */
1395 /* deal with options */
1396 #define NTREQ_IRLEN 1
1397 #define NTREQ_IRCAPTURE 2
1398 #define NTREQ_IRMASK 4
1400 /* clear them as we find them */
1401 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1404 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1406 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1409 LOG_DEBUG("Processing option: %s", n
->name
);
1411 case NTAP_OPT_ENABLED
:
1414 case NTAP_OPT_DISABLED
:
1417 case NTAP_OPT_EXPECTED_ID
:
1419 u32
*new_expected_ids
;
1421 e
= Jim_GetOpt_Wide( goi
, &w
);
1423 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1427 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1428 if (new_expected_ids
== NULL
) {
1429 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1433 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1435 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1437 free(pTap
->expected_ids
);
1438 pTap
->expected_ids
= new_expected_ids
;
1439 pTap
->expected_ids_cnt
++;
1442 case NTAP_OPT_IRLEN
:
1443 case NTAP_OPT_IRMASK
:
1444 case NTAP_OPT_IRCAPTURE
:
1445 e
= Jim_GetOpt_Wide( goi
, &w
);
1447 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1450 if( (w
< 0) || (w
> 0xffff) ){
1452 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1453 n
->name
, (int)(w
), (int)(w
));
1457 case NTAP_OPT_IRLEN
:
1458 pTap
->ir_length
= w
;
1459 reqbits
&= (~(NTREQ_IRLEN
));
1461 case NTAP_OPT_IRMASK
:
1462 pTap
->ir_capture_mask
= w
;
1463 reqbits
&= (~(NTREQ_IRMASK
));
1465 case NTAP_OPT_IRCAPTURE
:
1466 pTap
->ir_capture_value
= w
;
1467 reqbits
&= (~(NTREQ_IRCAPTURE
));
1470 } /* switch(n->value) */
1471 } /* while( goi->argc ) */
1473 /* Did all the required option bits get cleared? */
1476 jtag_tap_init(pTap
);
1480 Jim_SetResult_sprintf(goi
->interp
,
1481 "newtap: %s missing required parameters",
1483 jtag_tap_free(pTap
);
1487 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1493 struct command_context_s
*context
;
1497 JTAG_CMD_INIT_RESET
,
1500 JTAG_CMD_TAPDISABLE
,
1501 JTAG_CMD_TAPISENABLED
,
1506 const Jim_Nvp jtag_cmds
[] = {
1507 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1508 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1509 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1510 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1511 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1512 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1513 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1514 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1516 { .name
= NULL
, .value
= -1 },
1519 context
= Jim_GetAssocData(interp
, "context");
1520 /* go past the command */
1521 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1523 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1525 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1528 Jim_SetEmptyResult( goi
.interp
);
1530 case JTAG_CMD_INTERFACE
:
1531 /* return the name of the interface */
1532 /* TCL code might need to know the exact type... */
1533 /* FUTURE: we allow this as a means to "set" the interface. */
1534 if( goi
.argc
!= 0 ){
1535 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1538 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1540 case JTAG_CMD_INIT_RESET
:
1541 if( goi
.argc
!= 0 ){
1542 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1545 e
= jtag_init_reset(context
);
1546 if( e
!= ERROR_OK
){
1547 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1551 case JTAG_CMD_NEWTAP
:
1552 return jim_newtap_cmd( &goi
);
1554 case JTAG_CMD_TAPISENABLED
:
1555 case JTAG_CMD_TAPENABLE
:
1556 case JTAG_CMD_TAPDISABLE
:
1557 if( goi
.argc
!= 1 ){
1558 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1564 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1569 case JTAG_CMD_TAPISENABLED
:
1572 case JTAG_CMD_TAPENABLE
:
1573 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1577 case JTAG_CMD_TAPDISABLE
:
1578 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1583 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1590 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1597 Jim_GetOpt_Obj(&goi
, &o
);
1598 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1603 goi
.isconfigure
= 0;
1604 return jtag_tap_configure_cmd( &goi
, t
);
1608 case JTAG_CMD_CONFIGURE
:
1610 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1617 Jim_GetOpt_Obj(&goi
, &o
);
1618 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1623 goi
.isconfigure
= 1;
1624 return jtag_tap_configure_cmd( &goi
, t
);
1631 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1633 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1635 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1636 COMMAND_CONFIG
, "try to configure interface");
1637 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1638 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1639 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1640 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1641 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1642 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1643 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1644 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1646 "[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]");
1647 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1648 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1649 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1650 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1652 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1653 COMMAND_EXEC
, "print current scan chain configuration");
1655 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1656 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1657 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1658 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1659 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1660 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1661 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1662 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1664 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1665 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1666 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1667 COMMAND_ANY
, "verify value capture <enable|disable>");
1668 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1669 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1673 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1678 if (!jtag_interface
)
1680 /* nothing was previously specified by "interface" command */
1681 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1682 return ERROR_JTAG_INVALID_INTERFACE
;
1686 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1690 if (jtag_interface
->init() != ERROR_OK
)
1691 return ERROR_JTAG_INIT_FAILED
;
1693 jtag
= jtag_interface
;
1697 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1702 LOG_DEBUG("Init JTAG chain");
1704 tap
= jtag_tap_next_enabled(NULL
);
1706 LOG_ERROR("There are no enabled taps?");
1707 return ERROR_JTAG_INIT_FAILED
;
1711 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1714 /* examine chain first, as this could discover the real chain layout */
1715 if (jtag_examine_chain() != ERROR_OK
)
1717 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1720 if (jtag_validate_chain() != ERROR_OK
)
1722 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1728 int jtag_interface_quit(void)
1730 if (!jtag
|| !jtag
->quit
)
1733 // close the JTAG interface
1734 int result
= jtag
->quit();
1735 if (ERROR_OK
!= result
)
1736 LOG_ERROR("failed: %d", result
);
1742 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1746 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1749 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1751 /* Reset can happen after a power cycle.
1753 * Ideally we would only assert TRST or run RESET before the target reset.
1755 * However w/srst_pulls_trst, trst is asserted together with the target
1756 * reset whether we want it or not.
1758 * NB! Some targets have JTAG circuitry disabled until a
1759 * trst & srst has been asserted.
1761 * NB! here we assume nsrst/ntrst delay are sufficient!
1763 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1766 jtag_add_reset(1, 0); /* RESET or TRST */
1767 if (jtag_reset_config
& RESET_HAS_SRST
)
1769 jtag_add_reset(1, 1);
1770 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1771 jtag_add_reset(0, 1);
1773 jtag_add_reset(0, 0);
1774 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1777 /* Check that we can communication on the JTAG chain + eventually we want to
1778 * be able to perform enumeration only after OpenOCD has started
1779 * telnet and GDB server
1781 * That would allow users to more easily perform any magic they need to before
1784 return jtag_init_inner(cmd_ctx
);
1787 int jtag_init(struct command_context_s
*cmd_ctx
)
1790 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1792 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1796 return jtag_init_reset(cmd_ctx
);
1799 void jtag_set_speed_khz(unsigned khz
)
1803 unsigned jtag_get_speed_khz(void)
1808 static int default_khz(int khz
, int *jtag_speed
)
1810 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1814 static int default_speed_div(int speed
, int *khz
)
1816 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1820 static int default_power_dropout(int *dropout
)
1822 *dropout
=0; /* by default we can't detect power dropout */
1826 static int default_srst_asserted(int *srst_asserted
)
1828 *srst_asserted
=0; /* by default we can't detect srst asserted */
1832 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1837 /* check whether the interface is already configured */
1840 LOG_WARNING("Interface already configured, ignoring");
1844 /* interface name is a mandatory argument */
1845 if (argc
< 1 || args
[0][0] == '\0')
1847 return ERROR_COMMAND_SYNTAX_ERROR
;
1850 for (i
=0; jtag_interfaces
[i
]; i
++)
1852 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1854 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1859 jtag_interface
= jtag_interfaces
[i
];
1861 if (jtag_interface
->khz
== NULL
)
1863 jtag_interface
->khz
= default_khz
;
1865 if (jtag_interface
->speed_div
== NULL
)
1867 jtag_interface
->speed_div
= default_speed_div
;
1869 if (jtag_interface
->power_dropout
== NULL
)
1871 jtag_interface
->power_dropout
= default_power_dropout
;
1873 if (jtag_interface
->srst_asserted
== NULL
)
1875 jtag_interface
->srst_asserted
= default_srst_asserted
;
1882 /* no valid interface was found (i.e. the configuration option,
1883 * didn't match one of the compiled-in interfaces
1885 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1886 LOG_ERROR("compiled-in jtag interfaces:");
1887 for (i
= 0; jtag_interfaces
[i
]; i
++)
1889 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1892 return ERROR_JTAG_INVALID_INTERFACE
;
1895 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1899 Jim_Obj
*newargs
[ 10 ];
1902 * argv[-1] = command
1903 * argv[ 0] = ir length
1904 * argv[ 1] = ir capture
1905 * argv[ 2] = ir mask
1906 * argv[ 3] = not actually used by anything but in the docs
1910 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1913 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1914 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1918 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1919 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1920 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1921 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1923 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1924 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1925 sprintf( buf
, "chip%d", jtag_tap_count() );
1926 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1927 sprintf( buf
, "tap%d", jtag_tap_count() );
1928 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1929 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1930 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1931 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1932 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1933 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1934 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1936 command_print( cmd_ctx
, "NEW COMMAND:");
1937 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1938 Jim_GetString( newargs
[0], NULL
),
1939 Jim_GetString( newargs
[1], NULL
),
1940 Jim_GetString( newargs
[2], NULL
),
1941 Jim_GetString( newargs
[3], NULL
),
1942 Jim_GetString( newargs
[4], NULL
),
1943 Jim_GetString( newargs
[5], NULL
),
1944 Jim_GetString( newargs
[6], NULL
),
1945 Jim_GetString( newargs
[7], NULL
),
1946 Jim_GetString( newargs
[8], NULL
),
1947 Jim_GetString( newargs
[9], NULL
) );
1949 e
= jim_jtag_command( interp
, 10, newargs
);
1951 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1956 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1960 tap
= jtag_all_taps();
1961 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1962 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1965 u32 expected
, expected_mask
, cur_instr
, ii
;
1966 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1967 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1968 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1970 command_print(cmd_ctx
,
1971 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1972 tap
->abs_chain_position
,
1974 tap
->enabled
? 'Y' : 'n',
1976 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1982 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1983 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1984 tap
->expected_ids
[ii
]);
1987 tap
= tap
->next_tap
;
1993 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1999 return ERROR_COMMAND_SYNTAX_ERROR
;
2001 /* Original versions cared about the order of these tokens:
2002 * reset_config signals [combination [trst_type [srst_type]]]
2003 * They also clobbered the previous configuration even on error.
2005 * Here we don't care about the order, and only change values
2006 * which have been explicitly specified.
2008 for (; argc
; argc
--, args
++) {
2013 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2014 if (strcmp(*args
, "none") == 0)
2016 else if (strcmp(*args
, "trst_only") == 0)
2017 tmp
= RESET_HAS_TRST
;
2018 else if (strcmp(*args
, "srst_only") == 0)
2019 tmp
= RESET_HAS_SRST
;
2020 else if (strcmp(*args
, "trst_and_srst") == 0)
2021 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2025 LOG_ERROR("extra reset_config %s spec (%s)",
2027 return ERROR_INVALID_ARGUMENTS
;
2032 /* combination (options for broken wiring) */
2033 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2034 if (strcmp(*args
, "separate") == 0)
2035 /* separate reset lines - default */;
2036 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2037 tmp
|= RESET_SRST_PULLS_TRST
;
2038 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2039 tmp
|= RESET_TRST_PULLS_SRST
;
2040 else if (strcmp(*args
, "combined") == 0)
2041 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2045 LOG_ERROR("extra reset_config %s spec (%s)",
2046 "combination", *args
);
2047 return ERROR_INVALID_ARGUMENTS
;
2052 /* trst_type (NOP without HAS_TRST) */
2053 m
= RESET_TRST_OPEN_DRAIN
;
2054 if (strcmp(*args
, "trst_open_drain") == 0)
2055 tmp
|= RESET_TRST_OPEN_DRAIN
;
2056 else if (strcmp(*args
, "trst_push_pull") == 0)
2057 /* push/pull from adapter - default */;
2061 LOG_ERROR("extra reset_config %s spec (%s)",
2062 "trst_type", *args
);
2063 return ERROR_INVALID_ARGUMENTS
;
2068 /* srst_type (NOP without HAS_SRST) */
2069 m
|= RESET_SRST_PUSH_PULL
;
2070 if (strcmp(*args
, "srst_push_pull") == 0)
2071 tmp
|= RESET_SRST_PUSH_PULL
;
2072 else if (strcmp(*args
, "srst_open_drain") == 0)
2073 /* open drain from adapter - default */;
2077 LOG_ERROR("extra reset_config %s spec (%s)",
2078 "srst_type", *args
);
2079 return ERROR_INVALID_ARGUMENTS
;
2084 /* caller provided nonsense; fail */
2085 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2086 return ERROR_INVALID_ARGUMENTS
;
2089 /* Remember the bits which were specified (mask)
2090 * and their new values (new_cfg).
2096 /* clear previous values of those bits, save new values */
2097 jtag_reset_config
&= ~mask
;
2098 jtag_reset_config
|= new_cfg
;
2103 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2104 char *cmd
, char **args
, int argc
)
2107 return ERROR_COMMAND_SYNTAX_ERROR
;
2109 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2110 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2114 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2115 char *cmd
, char **args
, int argc
)
2118 return ERROR_COMMAND_SYNTAX_ERROR
;
2120 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2121 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2125 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2127 int retval
= ERROR_OK
;
2130 return ERROR_COMMAND_SYNTAX_ERROR
;
2133 LOG_DEBUG("handle jtag speed");
2136 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2138 /* this command can be called during CONFIG,
2139 * in which case jtag isn't initialized */
2141 retval
= jtag
->speed(cur_speed
);
2143 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2148 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2151 return ERROR_COMMAND_SYNTAX_ERROR
;
2153 int retval
= ERROR_OK
;
2157 LOG_DEBUG("handle jtag khz");
2159 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2162 LOG_DEBUG("have interface set up");
2164 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2165 if (ERROR_OK
!= retval
)
2167 jtag_set_speed_khz(0);
2170 cur_speed
= jtag_speed
= speed_div1
;
2172 retval
= jtag
->speed(cur_speed
);
2178 cur_speed
= jtag_get_speed_khz();
2181 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2182 if (ERROR_OK
!= retval
)
2187 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2189 command_print(cmd_ctx
, "RCLK - adaptive");
2194 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
2195 char *cmd
, char **args
, int argc
)
2198 return ERROR_COMMAND_SYNTAX_ERROR
;
2201 if (args
[0][0] == '1')
2203 else if (args
[0][0] == '0')
2206 return ERROR_COMMAND_SYNTAX_ERROR
;
2209 if (args
[1][0] == '1')
2211 else if (args
[1][0] == '0')
2214 return ERROR_COMMAND_SYNTAX_ERROR
;
2216 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2217 return ERROR_JTAG_INIT_FAILED
;
2219 jtag_add_reset(trst
, srst
);
2220 jtag_execute_queue();
2225 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
2226 char *cmd
, char **args
, int argc
)
2229 return ERROR_COMMAND_SYNTAX_ERROR
;
2231 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2232 jtag_execute_queue();
2238 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2239 * should be stable ... and *NOT* a shift state, otherwise free-running
2240 * jtag clocks could change the values latched by the update state.
2242 static bool scan_is_safe(tap_state_t state
)
2257 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2260 scan_field_t
*fields
;
2262 tap_state_t endstate
;
2264 if ((argc
< 2) || (argc
% 2))
2266 return ERROR_COMMAND_SYNTAX_ERROR
;
2269 /* optional "-endstate" "statename" at the end of the arguments,
2270 * so that e.g. IRPAUSE can let us load the data register before
2271 * entering RUN/IDLE to execute the instruction we load here.
2273 endstate
= TAP_IDLE
;
2276 /* have at least one pair of numbers. */
2277 /* is last pair the magic text? */
2278 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2281 cpA
= args
[ argc
-1 ];
2282 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2283 cpS
= tap_state_name( endstate
);
2284 if( 0 == strcmp( cpA
, cpS
) ){
2288 if( endstate
>= TAP_NUM_STATES
){
2289 return ERROR_COMMAND_SYNTAX_ERROR
;
2291 if (!scan_is_safe(endstate
))
2292 LOG_WARNING("irscan with unsafe "
2293 "endstate \"%s\"", cpA
);
2294 /* found - remove the last 2 args */
2300 int num_fields
= argc
/ 2;
2302 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2304 for (i
= 0; i
< num_fields
; i
++)
2306 tap
= jtag_tap_by_string( args
[i
*2] );
2309 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2312 int field_size
= tap
->ir_length
;
2313 fields
[i
].tap
= tap
;
2314 fields
[i
].num_bits
= field_size
;
2315 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2316 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2317 fields
[i
].in_value
= NULL
;
2320 /* did we have an endstate? */
2321 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2323 int retval
=jtag_execute_queue();
2325 for (i
= 0; i
< num_fields
; i
++)
2326 free(fields
[i
].out_value
);
2333 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2336 scan_field_t
*fields
;
2338 int field_count
= 0;
2341 tap_state_t endstate
;
2344 * args[2] = num_bits
2345 * args[3] = hex string
2346 * ... repeat num bits and hex string ...
2349 * args[N-2] = "-endstate"
2350 * args[N-1] = statename
2352 if ((argc
< 4) || ((argc
% 2)!=0))
2354 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2358 endstate
= TAP_IDLE
;
2360 /* validate arguments as numbers */
2362 for (i
= 2; i
< argc
; i
+=2)
2367 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2368 /* If valid - try next arg */
2373 /* Not valid.. are we at the end? */
2374 if ( ((i
+2) != argc
) ){
2375 /* nope, then error */
2379 /* it could be: "-endstate FOO"
2380 * e.g. DRPAUSE so we can issue more instructions
2381 * before entering RUN/IDLE and executing them.
2384 /* get arg as a string. */
2385 cp
= Jim_GetString( args
[i
], NULL
);
2386 /* is it the magic? */
2387 if( 0 == strcmp( "-endstate", cp
) ){
2388 /* is the statename valid? */
2389 cp
= Jim_GetString( args
[i
+1], NULL
);
2391 /* see if it is a valid state name */
2392 endstate
= tap_state_by_name(cp
);
2394 /* update the error message */
2395 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2397 if (!scan_is_safe(endstate
))
2398 LOG_WARNING("drscan with unsafe "
2399 "endstate \"%s\"", cp
);
2401 /* valid - so clear the error */
2403 /* and remove the last 2 args */
2408 /* Still an error? */
2410 return e
; /* too bad */
2412 } /* validate args */
2414 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2419 num_fields
=(argc
-2)/2;
2420 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2421 for (i
= 2; i
< argc
; i
+=2)
2427 Jim_GetLong(interp
, args
[i
], &bits
);
2428 str
= Jim_GetString(args
[i
+1], &len
);
2430 fields
[field_count
].tap
= tap
;
2431 fields
[field_count
].num_bits
= bits
;
2432 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2433 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2434 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2438 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2440 retval
= jtag_execute_queue();
2441 if (retval
!= ERROR_OK
)
2443 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2448 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2449 for (i
= 2; i
< argc
; i
+=2)
2454 Jim_GetLong(interp
, args
[i
], &bits
);
2455 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2456 free(fields
[field_count
].out_value
);
2458 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2463 Jim_SetResult(interp
, list
);
2471 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2473 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2479 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2483 if (strcmp(args
[0], "enable") == 0)
2485 jtag_verify_capture_ir
= 1;
2487 else if (strcmp(args
[0], "disable") == 0)
2489 jtag_verify_capture_ir
= 0;
2492 return ERROR_COMMAND_SYNTAX_ERROR
;
2494 } else if (argc
!= 0)
2496 return ERROR_COMMAND_SYNTAX_ERROR
;
2499 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2504 void jtag_set_verify(bool enable
)
2506 jtag_verify
= enable
;
2509 bool jtag_will_verify()
2514 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2517 return ERROR_COMMAND_SYNTAX_ERROR
;
2521 if (strcmp(args
[0], "enable") == 0)
2522 jtag_set_verify(true);
2523 else if (strcmp(args
[0], "disable") == 0)
2524 jtag_set_verify(false);
2526 return ERROR_COMMAND_SYNTAX_ERROR
;
2529 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2530 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2536 int jtag_power_dropout(int *dropout
)
2538 return jtag
->power_dropout(dropout
);
2541 int jtag_srst_asserted(int *srst_asserted
)
2543 return jtag
->srst_asserted(srst_asserted
);
2546 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2548 jtag_tap_event_action_t
* jteap
;
2551 jteap
= tap
->event_action
;
2555 if (jteap
->event
== e
) {
2557 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2560 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2561 Jim_GetString(jteap
->body
, NULL
) );
2562 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2563 Jim_PrintErrorMessage(interp
);
2567 jteap
= jteap
->next
;
2571 LOG_DEBUG( "event %d %s - no action",
2573 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2577 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2580 return ERROR_COMMAND_SYNTAX_ERROR
;
2585 if (strcmp(args
[0], "short") == 0)
2586 use_new_table
= true;
2587 else if (strcmp(args
[0], "long") == 0)
2588 use_new_table
= false;
2590 return ERROR_COMMAND_SYNTAX_ERROR
;
2592 tap_use_new_tms_table(use_new_table
);
2595 command_print(cmd_ctx
, "tms sequence is %s",
2596 tap_uses_new_tms_table() ? "short": "long");
2602 * Function jtag_add_statemove
2603 * moves from the current state to the goal \a state. This needs
2604 * to be handled according to the xsvf spec, see the XSTATE command
2607 int jtag_add_statemove(tap_state_t goal_state
)
2609 int retval
= ERROR_OK
;
2611 tap_state_t moves
[8];
2612 tap_state_t cur_state
= cmd_queue_cur_state
;
2617 LOG_DEBUG( "cur_state=%s goal_state=%s",
2618 tap_state_name(cur_state
),
2619 tap_state_name(goal_state
) );
2622 /* From the XSVF spec, pertaining to XSTATE:
2624 For special states known as stable states (Test-Logic-Reset,
2625 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2626 predefined TAP state paths when the starting state is a stable state and
2627 when the XSTATE specifies a new stable state (see the STATE command in
2628 the [Ref 5] for the TAP state paths between stable states). For
2629 non-stable states, XSTATE should specify a state that is only one TAP
2630 state transition distance from the current TAP state to avoid undefined
2631 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2632 transition the TAP through a specific state path.
2635 if (goal_state
==cur_state
)
2636 ; /* nothing to do */
2638 else if( goal_state
==TAP_RESET
)
2643 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2645 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2646 spec, then this code is not fully conformant to the xsvf spec. This
2647 puts a burden on tap_get_tms_path() function from the xsvf spec.
2648 If in doubt, you should confirm that that burden is being met.
2651 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2652 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2654 assert( (unsigned) tms_count
< DIM(moves
) );
2656 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2658 bool bit
= tms_bits
& 1;
2660 cur_state
= tap_state_transition(cur_state
, bit
);
2661 moves
[i
] = cur_state
;
2664 jtag_add_pathmove(tms_count
, moves
);
2667 /* else state must be immediately reachable in one clock cycle, and does not
2668 need to be a stable state.
2670 else if( tap_state_transition(cur_state
, true) == goal_state
2671 || tap_state_transition(cur_state
, false) == goal_state
)
2673 /* move a single state */
2674 moves
[0] = goal_state
;
2675 jtag_add_pathmove( 1, moves
);
2680 retval
= ERROR_FAIL
;
2686 void jtag_set_nsrst_delay(unsigned delay
)
2688 jtag_nsrst_delay
= delay
;
2690 unsigned jtag_get_nsrst_delay(void)
2692 return jtag_nsrst_delay
;
2694 void jtag_set_ntrst_delay(unsigned delay
)
2696 jtag_ntrst_delay
= delay
;
2698 unsigned jtag_get_ntrst_delay(void)
2700 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)