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
);
602 jtag_set_error(interface_jtag_add_tlr());
603 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
606 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
608 tap_state_t cur_state
= cmd_queue_cur_state
;
610 /* the last state has to be a stable state */
611 if (!tap_is_state_stable(path
[num_states
- 1]))
613 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
617 for (int i
= 0; i
< num_states
; i
++)
619 if (path
[i
] == TAP_RESET
)
621 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
625 if ( tap_state_transition(cur_state
, true) != path
[i
]
626 && tap_state_transition(cur_state
, false) != path
[i
])
628 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
629 tap_state_name(cur_state
), tap_state_name(path
[i
]));
637 jtag_set_error(interface_jtag_add_pathmove(num_states
, path
));
638 cmd_queue_cur_state
= path
[num_states
- 1];
641 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
644 jtag_set_error(interface_jtag_add_runtest(num_cycles
, state
));
648 void jtag_add_clocks( int num_cycles
)
652 if( !tap_is_state_stable(cmd_queue_cur_state
) )
654 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
655 tap_state_name(cmd_queue_cur_state
) );
656 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
664 retval
= interface_jtag_add_clocks(num_cycles
);
665 if (retval
!= ERROR_OK
)
670 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
672 int trst_with_tlr
= 0;
675 /* FIX!!! there are *many* different cases here. A better
676 * approach is needed for legal combinations of transitions...
678 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
679 (jtag_reset_config
& RESET_HAS_TRST
)&&
680 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
682 if (((req_tlr_or_trst
&&!jtag_trst
)||
683 (!req_tlr_or_trst
&&jtag_trst
))&&
684 ((req_srst
&&!jtag_srst
)||
685 (!req_srst
&&jtag_srst
)))
687 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
688 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
692 /* Make sure that jtag_reset_config allows the requested reset */
693 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
694 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
696 LOG_ERROR("BUG: requested reset would assert trst");
697 jtag_error
=ERROR_FAIL
;
701 /* if TRST pulls SRST, we reset with TAP T-L-R */
702 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
707 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
709 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
710 jtag_error
=ERROR_FAIL
;
716 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
728 jtag_srst
= req_srst
;
730 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
731 if (retval
!=ERROR_OK
)
736 jtag_execute_queue();
740 LOG_DEBUG("SRST line asserted");
744 LOG_DEBUG("SRST line released");
745 if (jtag_nsrst_delay
)
746 jtag_add_sleep(jtag_nsrst_delay
* 1000);
751 LOG_DEBUG("JTAG reset with RESET instead of TRST");
752 jtag_set_end_state(TAP_RESET
);
759 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
760 * and inform possible listeners about this
762 LOG_DEBUG("TRST line asserted");
763 tap_set_state(TAP_RESET
);
764 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
768 if (jtag_ntrst_delay
)
769 jtag_add_sleep(jtag_ntrst_delay
* 1000);
773 tap_state_t
jtag_set_end_state(tap_state_t state
)
775 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
777 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
780 if (state
!=TAP_INVALID
)
781 cmd_queue_end_state
= state
;
782 return cmd_queue_end_state
;
785 tap_state_t
jtag_get_end_state(void)
787 return cmd_queue_end_state
;
790 void jtag_add_sleep(u32 us
)
792 keep_alive(); /* we might be running on a very slow JTAG clk */
793 int retval
=interface_jtag_add_sleep(us
);
794 if (retval
!=ERROR_OK
)
799 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
801 int retval
= ERROR_OK
;
803 int compare_failed
= 0;
806 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
808 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
811 /* An error handler could have caught the failing check
812 * only report a problem when there wasn't a handler, or if the handler
813 * acknowledged the error
816 LOG_WARNING("TAP %s:",
817 jtag_tap_name(field->tap));
821 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
822 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
826 char *in_check_mask_char
;
827 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
828 LOG_WARNING("value captured during scan didn't pass the requested check:");
829 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
830 captured_char
, in_check_value_char
, in_check_mask_char
);
831 free(in_check_mask_char
);
835 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
);
839 free(in_check_value_char
);
841 retval
= ERROR_JTAG_QUEUE_FAILED
;
848 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
850 assert(field
->in_value
!= NULL
);
854 /* no checking to do */
858 jtag_execute_queue_noclear();
860 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
861 jtag_set_error(retval
);
866 int default_interface_jtag_execute_queue(void)
870 LOG_ERROR("No JTAG interface configured yet. "
871 "Issue 'init' command in startup scripts "
872 "before communicating with targets.");
876 return jtag
->execute_queue();
879 void jtag_execute_queue_noclear(void)
881 jtag_flush_queue_count
++;
882 jtag_set_error(interface_jtag_execute_queue());
885 int jtag_get_flush_queue_count(void)
887 return jtag_flush_queue_count
;
890 int jtag_execute_queue(void)
892 jtag_execute_queue_noclear();
893 return jtag_error_clear();
896 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
898 jtag_tap_t
*tap
= priv
;
902 if (event
== JTAG_TRST_ASSERTED
)
904 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
911 void jtag_sleep(u32 us
)
913 alive_sleep(us
/1000);
916 /// maximum number of JTAG devices expected in the chain
917 #define JTAG_MAX_CHAIN_SIZE 20
919 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
920 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
921 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
923 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
925 scan_field_t field
= {
927 .num_bits
= num_idcode
* 32,
928 .out_value
= idcode_buffer
,
929 .in_value
= idcode_buffer
,
932 // initialize to the end of chain ID value
933 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
934 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
936 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
937 return jtag_execute_queue();
940 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
945 for (unsigned i
= 0; i
< count
* 4; i
++)
947 zero_check
|= idcodes
[i
];
948 one_check
&= idcodes
[i
];
951 /* if there wasn't a single non-zero bit or if all bits were one,
952 * the scan is not valid */
953 if (zero_check
== 0x00 || one_check
== 0xff)
955 LOG_ERROR("JTAG communication failure: check connection, "
956 "JTAG interface, target power etc.");
962 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
963 const char *name
, u32 idcode
)
965 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
966 "JTAG tap: %s %16.16s: 0x%08x "
967 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
969 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
972 static bool jtag_idcode_is_final(u32 idcode
)
974 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
978 * This helper checks that remaining bits in the examined chain data are
979 * all as expected, but a single JTAG device requires only 64 bits to be
980 * read back correctly. This can help identify and diagnose problems
981 * with the JTAG chain earlier, gives more helpful/explicit error messages.
983 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
985 bool triggered
= false;
986 for ( ; count
< max
- 31; count
+= 32)
988 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
989 // do not trigger the warning if the data looks good
990 if (!triggered
&& jtag_idcode_is_final(idcode
))
992 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
998 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1000 if (0 == tap
->expected_ids_cnt
)
1002 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1004 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1005 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1010 /* Loop over the expected identification codes and test for a match */
1012 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1014 if (tap
->idcode
== tap
->expected_ids
[ii
])
1018 /* If none of the expected ids matched, log an error */
1019 if (ii
!= tap
->expected_ids_cnt
)
1021 LOG_INFO("JTAG Tap/device matched");
1024 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1025 tap
->dotted_name
, tap
->idcode
);
1026 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1029 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1030 ii
+ 1, tap
->expected_ids_cnt
);
1031 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1032 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1037 /* Try to examine chain layout according to IEEE 1149.1 §12
1039 static int jtag_examine_chain(void)
1041 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1042 unsigned device_count
= 0;
1044 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1046 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1047 return ERROR_JTAG_INIT_FAILED
;
1049 /* point at the 1st tap */
1050 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1053 LOG_ERROR("JTAG: No taps enabled?");
1054 return ERROR_JTAG_INIT_FAILED
;
1057 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1059 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1060 if ((idcode
& 1) == 0)
1062 /* LSB must not be 0, this indicates a device in bypass */
1063 LOG_WARNING("Tap/Device does not have IDCODE");
1071 * End of chain (invalid manufacturer ID) some devices, such
1072 * as AVR will output all 1's instead of TDI input value at
1075 if (jtag_idcode_is_final(idcode
))
1077 jtag_examine_chain_end(idcode_buffer
,
1078 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1082 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1083 tap
? tap
->dotted_name
: "(not-named)",
1092 tap
->idcode
= idcode
;
1094 // ensure the TAP ID does matches what was expected
1095 if (!jtag_examine_chain_match_tap(tap
))
1096 return ERROR_JTAG_INIT_FAILED
;
1098 tap
= jtag_tap_next_enabled(tap
);
1101 /* see if number of discovered devices matches configuration */
1102 if (device_count
!= jtag_tap_count_enabled())
1104 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1105 "does not match (enabled) configuration (%i), total taps: %d",
1106 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1107 LOG_ERROR("check the config file and ensure proper JTAG communication"
1108 " (connections, speed, ...)");
1109 return ERROR_JTAG_INIT_FAILED
;
1115 static int jtag_validate_chain(void)
1118 int total_ir_length
= 0;
1124 total_ir_length
= 0;
1126 tap
= jtag_tap_next_enabled(tap
);
1130 total_ir_length
+= tap
->ir_length
;
1133 total_ir_length
+= 2;
1134 ir_test
= malloc(CEIL(total_ir_length
, 8));
1135 buf_set_ones(ir_test
, total_ir_length
);
1138 field
.num_bits
= total_ir_length
;
1139 field
.out_value
= ir_test
;
1140 field
.in_value
= ir_test
;
1143 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1144 jtag_execute_queue();
1150 tap
= jtag_tap_next_enabled(tap
);
1155 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1158 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1159 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
);
1162 return ERROR_JTAG_INIT_FAILED
;
1164 chain_pos
+= tap
->ir_length
;
1167 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1170 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1171 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
);
1174 return ERROR_JTAG_INIT_FAILED
;
1182 enum jtag_tap_cfg_param
{
1186 static Jim_Nvp nvp_config_opts
[] = {
1187 { .name
= "-event", .value
= JCFG_EVENT
},
1189 { .name
= NULL
, .value
= -1 }
1192 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1198 /* parse config or cget options */
1199 while (goi
->argc
> 0) {
1200 Jim_SetEmptyResult (goi
->interp
);
1202 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1204 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1210 if (goi
->argc
== 0) {
1211 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1215 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1217 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1221 if (goi
->isconfigure
) {
1222 if (goi
->argc
!= 1) {
1223 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1227 if (goi
->argc
!= 0) {
1228 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1234 jtag_tap_event_action_t
*jteap
;
1236 jteap
= tap
->event_action
;
1237 /* replace existing? */
1239 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1242 jteap
= jteap
->next
;
1245 if (goi
->isconfigure
) {
1246 if (jteap
== NULL
) {
1248 jteap
= calloc(1, sizeof (*jteap
));
1250 jteap
->event
= n
->value
;
1251 Jim_GetOpt_Obj( goi
, &o
);
1253 Jim_DecrRefCount(interp
, jteap
->body
);
1255 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1256 Jim_IncrRefCount(jteap
->body
);
1258 /* add to head of event list */
1259 jteap
->next
= tap
->event_action
;
1260 tap
->event_action
= jteap
;
1261 Jim_SetEmptyResult(goi
->interp
);
1264 if (jteap
== NULL
) {
1265 Jim_SetEmptyResult(goi
->interp
);
1267 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1274 } /* while (goi->argc) */
1280 static void jtag_tap_init(jtag_tap_t
*tap
)
1282 assert(0 != tap
->ir_length
);
1284 tap
->expected
= malloc(tap
->ir_length
);
1285 tap
->expected_mask
= malloc(tap
->ir_length
);
1286 tap
->cur_instr
= malloc(tap
->ir_length
);
1288 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1289 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1290 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1292 // place TAP in bypass mode
1294 // register the reset callback for the TAP
1295 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1297 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1298 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1299 tap
->abs_chain_position
, tap
->ir_length
,
1300 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1304 static void jtag_tap_free(jtag_tap_t
*tap
)
1306 /// @todo is anything missing? no memory leaks please
1307 free((void *)tap
->expected_ids
);
1308 free((void *)tap
->chip
);
1309 free((void *)tap
->tapname
);
1310 free((void *)tap
->dotted_name
);
1314 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1323 const Jim_Nvp opts
[] = {
1324 #define NTAP_OPT_IRLEN 0
1325 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1326 #define NTAP_OPT_IRMASK 1
1327 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1328 #define NTAP_OPT_IRCAPTURE 2
1329 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1330 #define NTAP_OPT_ENABLED 3
1331 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1332 #define NTAP_OPT_DISABLED 4
1333 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1334 #define NTAP_OPT_EXPECTED_ID 5
1335 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1336 { .name
= NULL
, .value
= -1 },
1339 pTap
= malloc( sizeof(jtag_tap_t
) );
1340 memset( pTap
, 0, sizeof(*pTap
) );
1342 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1346 * we expect CHIP + TAP + OPTIONS
1348 if( goi
->argc
< 3 ){
1349 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1352 Jim_GetOpt_String( goi
, &cp
, NULL
);
1353 pTap
->chip
= strdup(cp
);
1355 Jim_GetOpt_String( goi
, &cp
, NULL
);
1356 pTap
->tapname
= strdup(cp
);
1358 /* name + dot + name + null */
1359 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1361 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1362 pTap
->dotted_name
= cp
;
1364 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1365 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1367 /* default is enabled */
1370 /* deal with options */
1371 #define NTREQ_IRLEN 1
1372 #define NTREQ_IRCAPTURE 2
1373 #define NTREQ_IRMASK 4
1375 /* clear them as we find them */
1376 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1379 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1381 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1384 LOG_DEBUG("Processing option: %s", n
->name
);
1386 case NTAP_OPT_ENABLED
:
1389 case NTAP_OPT_DISABLED
:
1392 case NTAP_OPT_EXPECTED_ID
:
1394 u32
*new_expected_ids
;
1396 e
= Jim_GetOpt_Wide( goi
, &w
);
1398 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1402 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1403 if (new_expected_ids
== NULL
) {
1404 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1408 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1410 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1412 free(pTap
->expected_ids
);
1413 pTap
->expected_ids
= new_expected_ids
;
1414 pTap
->expected_ids_cnt
++;
1417 case NTAP_OPT_IRLEN
:
1418 case NTAP_OPT_IRMASK
:
1419 case NTAP_OPT_IRCAPTURE
:
1420 e
= Jim_GetOpt_Wide( goi
, &w
);
1422 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1425 if( (w
< 0) || (w
> 0xffff) ){
1427 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1428 n
->name
, (int)(w
), (int)(w
));
1432 case NTAP_OPT_IRLEN
:
1433 pTap
->ir_length
= w
;
1434 reqbits
&= (~(NTREQ_IRLEN
));
1436 case NTAP_OPT_IRMASK
:
1437 pTap
->ir_capture_mask
= w
;
1438 reqbits
&= (~(NTREQ_IRMASK
));
1440 case NTAP_OPT_IRCAPTURE
:
1441 pTap
->ir_capture_value
= w
;
1442 reqbits
&= (~(NTREQ_IRCAPTURE
));
1445 } /* switch(n->value) */
1446 } /* while( goi->argc ) */
1448 /* Did all the required option bits get cleared? */
1451 jtag_tap_init(pTap
);
1455 Jim_SetResult_sprintf(goi
->interp
,
1456 "newtap: %s missing required parameters",
1458 jtag_tap_free(pTap
);
1462 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1468 struct command_context_s
*context
;
1472 JTAG_CMD_INIT_RESET
,
1475 JTAG_CMD_TAPDISABLE
,
1476 JTAG_CMD_TAPISENABLED
,
1481 const Jim_Nvp jtag_cmds
[] = {
1482 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1483 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1484 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1485 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1486 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1487 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1488 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1489 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1491 { .name
= NULL
, .value
= -1 },
1494 context
= Jim_GetAssocData(interp
, "context");
1495 /* go past the command */
1496 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1498 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1500 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1503 Jim_SetEmptyResult( goi
.interp
);
1505 case JTAG_CMD_INTERFACE
:
1506 /* return the name of the interface */
1507 /* TCL code might need to know the exact type... */
1508 /* FUTURE: we allow this as a means to "set" the interface. */
1509 if( goi
.argc
!= 0 ){
1510 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1513 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1515 case JTAG_CMD_INIT_RESET
:
1516 if( goi
.argc
!= 0 ){
1517 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1520 e
= jtag_init_reset(context
);
1521 if( e
!= ERROR_OK
){
1522 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1526 case JTAG_CMD_NEWTAP
:
1527 return jim_newtap_cmd( &goi
);
1529 case JTAG_CMD_TAPISENABLED
:
1530 case JTAG_CMD_TAPENABLE
:
1531 case JTAG_CMD_TAPDISABLE
:
1532 if( goi
.argc
!= 1 ){
1533 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1539 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1544 case JTAG_CMD_TAPISENABLED
:
1547 case JTAG_CMD_TAPENABLE
:
1548 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1552 case JTAG_CMD_TAPDISABLE
:
1553 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1558 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1565 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1572 Jim_GetOpt_Obj(&goi
, &o
);
1573 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1578 goi
.isconfigure
= 0;
1579 return jtag_tap_configure_cmd( &goi
, t
);
1583 case JTAG_CMD_CONFIGURE
:
1585 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1592 Jim_GetOpt_Obj(&goi
, &o
);
1593 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1598 goi
.isconfigure
= 1;
1599 return jtag_tap_configure_cmd( &goi
, t
);
1606 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1608 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1610 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1611 COMMAND_CONFIG
, "try to configure interface");
1612 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1613 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1614 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1615 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1616 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1617 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1618 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1619 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1621 "[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]");
1622 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1623 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1624 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1625 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1627 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1628 COMMAND_EXEC
, "print current scan chain configuration");
1630 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1631 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1632 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1633 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1634 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1635 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1636 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1637 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1639 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1640 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1641 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1642 COMMAND_ANY
, "verify value capture <enable|disable>");
1643 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1644 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1648 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1653 if (!jtag_interface
)
1655 /* nothing was previously specified by "interface" command */
1656 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1657 return ERROR_JTAG_INVALID_INTERFACE
;
1661 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1665 if (jtag_interface
->init() != ERROR_OK
)
1666 return ERROR_JTAG_INIT_FAILED
;
1668 jtag
= jtag_interface
;
1672 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1677 LOG_DEBUG("Init JTAG chain");
1679 tap
= jtag_tap_next_enabled(NULL
);
1681 LOG_ERROR("There are no enabled taps?");
1682 return ERROR_JTAG_INIT_FAILED
;
1686 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1689 /* examine chain first, as this could discover the real chain layout */
1690 if (jtag_examine_chain() != ERROR_OK
)
1692 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1695 if (jtag_validate_chain() != ERROR_OK
)
1697 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1703 int jtag_interface_quit(void)
1705 if (!jtag
|| !jtag
->quit
)
1708 // close the JTAG interface
1709 int result
= jtag
->quit();
1710 if (ERROR_OK
!= result
)
1711 LOG_ERROR("failed: %d", result
);
1717 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1721 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1724 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1726 /* Reset can happen after a power cycle.
1728 * Ideally we would only assert TRST or run RESET before the target reset.
1730 * However w/srst_pulls_trst, trst is asserted together with the target
1731 * reset whether we want it or not.
1733 * NB! Some targets have JTAG circuitry disabled until a
1734 * trst & srst has been asserted.
1736 * NB! here we assume nsrst/ntrst delay are sufficient!
1738 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1741 jtag_add_reset(1, 0); /* RESET or TRST */
1742 if (jtag_reset_config
& RESET_HAS_SRST
)
1744 jtag_add_reset(1, 1);
1745 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1746 jtag_add_reset(0, 1);
1748 jtag_add_reset(0, 0);
1749 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1752 /* Check that we can communication on the JTAG chain + eventually we want to
1753 * be able to perform enumeration only after OpenOCD has started
1754 * telnet and GDB server
1756 * That would allow users to more easily perform any magic they need to before
1759 return jtag_init_inner(cmd_ctx
);
1762 int jtag_init(struct command_context_s
*cmd_ctx
)
1765 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1767 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1771 return jtag_init_reset(cmd_ctx
);
1774 void jtag_set_speed_khz(unsigned khz
)
1778 unsigned jtag_get_speed_khz(void)
1783 static int default_khz(int khz
, int *jtag_speed
)
1785 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1789 static int default_speed_div(int speed
, int *khz
)
1791 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1795 static int default_power_dropout(int *dropout
)
1797 *dropout
=0; /* by default we can't detect power dropout */
1801 static int default_srst_asserted(int *srst_asserted
)
1803 *srst_asserted
=0; /* by default we can't detect srst asserted */
1807 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1812 /* check whether the interface is already configured */
1815 LOG_WARNING("Interface already configured, ignoring");
1819 /* interface name is a mandatory argument */
1820 if (argc
< 1 || args
[0][0] == '\0')
1822 return ERROR_COMMAND_SYNTAX_ERROR
;
1825 for (i
=0; jtag_interfaces
[i
]; i
++)
1827 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1829 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1834 jtag_interface
= jtag_interfaces
[i
];
1836 if (jtag_interface
->khz
== NULL
)
1838 jtag_interface
->khz
= default_khz
;
1840 if (jtag_interface
->speed_div
== NULL
)
1842 jtag_interface
->speed_div
= default_speed_div
;
1844 if (jtag_interface
->power_dropout
== NULL
)
1846 jtag_interface
->power_dropout
= default_power_dropout
;
1848 if (jtag_interface
->srst_asserted
== NULL
)
1850 jtag_interface
->srst_asserted
= default_srst_asserted
;
1857 /* no valid interface was found (i.e. the configuration option,
1858 * didn't match one of the compiled-in interfaces
1860 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1861 LOG_ERROR("compiled-in jtag interfaces:");
1862 for (i
= 0; jtag_interfaces
[i
]; i
++)
1864 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1867 return ERROR_JTAG_INVALID_INTERFACE
;
1870 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1874 Jim_Obj
*newargs
[ 10 ];
1877 * argv[-1] = command
1878 * argv[ 0] = ir length
1879 * argv[ 1] = ir capture
1880 * argv[ 2] = ir mask
1881 * argv[ 3] = not actually used by anything but in the docs
1885 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1888 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1889 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1893 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1894 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1895 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1896 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1898 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1899 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1900 sprintf( buf
, "chip%d", jtag_tap_count() );
1901 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1902 sprintf( buf
, "tap%d", jtag_tap_count() );
1903 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1904 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1905 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1906 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1907 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1908 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1909 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1911 command_print( cmd_ctx
, "NEW COMMAND:");
1912 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1913 Jim_GetString( newargs
[0], NULL
),
1914 Jim_GetString( newargs
[1], NULL
),
1915 Jim_GetString( newargs
[2], NULL
),
1916 Jim_GetString( newargs
[3], NULL
),
1917 Jim_GetString( newargs
[4], NULL
),
1918 Jim_GetString( newargs
[5], NULL
),
1919 Jim_GetString( newargs
[6], NULL
),
1920 Jim_GetString( newargs
[7], NULL
),
1921 Jim_GetString( newargs
[8], NULL
),
1922 Jim_GetString( newargs
[9], NULL
) );
1924 e
= jim_jtag_command( interp
, 10, newargs
);
1926 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1931 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1935 tap
= jtag_all_taps();
1936 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1937 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1940 u32 expected
, expected_mask
, cur_instr
, ii
;
1941 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1942 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1943 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1945 command_print(cmd_ctx
,
1946 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1947 tap
->abs_chain_position
,
1949 tap
->enabled
? 'Y' : 'n',
1951 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1957 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1958 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1959 tap
->expected_ids
[ii
]);
1962 tap
= tap
->next_tap
;
1968 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1974 return ERROR_COMMAND_SYNTAX_ERROR
;
1976 /* Original versions cared about the order of these tokens:
1977 * reset_config signals [combination [trst_type [srst_type]]]
1978 * They also clobbered the previous configuration even on error.
1980 * Here we don't care about the order, and only change values
1981 * which have been explicitly specified.
1983 for (; argc
; argc
--, args
++) {
1988 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
1989 if (strcmp(*args
, "none") == 0)
1991 else if (strcmp(*args
, "trst_only") == 0)
1992 tmp
= RESET_HAS_TRST
;
1993 else if (strcmp(*args
, "srst_only") == 0)
1994 tmp
= RESET_HAS_SRST
;
1995 else if (strcmp(*args
, "trst_and_srst") == 0)
1996 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2000 LOG_ERROR("extra reset_config %s spec (%s)",
2002 return ERROR_INVALID_ARGUMENTS
;
2007 /* combination (options for broken wiring) */
2008 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2009 if (strcmp(*args
, "separate") == 0)
2010 /* separate reset lines - default */;
2011 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2012 tmp
|= RESET_SRST_PULLS_TRST
;
2013 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2014 tmp
|= RESET_TRST_PULLS_SRST
;
2015 else if (strcmp(*args
, "combined") == 0)
2016 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2020 LOG_ERROR("extra reset_config %s spec (%s)",
2021 "combination", *args
);
2022 return ERROR_INVALID_ARGUMENTS
;
2027 /* trst_type (NOP without HAS_TRST) */
2028 m
= RESET_TRST_OPEN_DRAIN
;
2029 if (strcmp(*args
, "trst_open_drain") == 0)
2030 tmp
|= RESET_TRST_OPEN_DRAIN
;
2031 else if (strcmp(*args
, "trst_push_pull") == 0)
2032 /* push/pull from adapter - default */;
2036 LOG_ERROR("extra reset_config %s spec (%s)",
2037 "trst_type", *args
);
2038 return ERROR_INVALID_ARGUMENTS
;
2043 /* srst_type (NOP without HAS_SRST) */
2044 m
|= RESET_SRST_PUSH_PULL
;
2045 if (strcmp(*args
, "srst_push_pull") == 0)
2046 tmp
|= RESET_SRST_PUSH_PULL
;
2047 else if (strcmp(*args
, "srst_open_drain") == 0)
2048 /* open drain from adapter - default */;
2052 LOG_ERROR("extra reset_config %s spec (%s)",
2053 "srst_type", *args
);
2054 return ERROR_INVALID_ARGUMENTS
;
2059 /* caller provided nonsense; fail */
2060 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2061 return ERROR_INVALID_ARGUMENTS
;
2064 /* Remember the bits which were specified (mask)
2065 * and their new values (new_cfg).
2071 /* clear previous values of those bits, save new values */
2072 jtag_reset_config
&= ~mask
;
2073 jtag_reset_config
|= new_cfg
;
2078 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2079 char *cmd
, char **args
, int argc
)
2082 return ERROR_COMMAND_SYNTAX_ERROR
;
2084 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2085 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2089 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2090 char *cmd
, char **args
, int argc
)
2093 return ERROR_COMMAND_SYNTAX_ERROR
;
2095 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2096 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2100 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2102 int retval
= ERROR_OK
;
2105 return ERROR_COMMAND_SYNTAX_ERROR
;
2108 LOG_DEBUG("handle jtag speed");
2111 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2113 /* this command can be called during CONFIG,
2114 * in which case jtag isn't initialized */
2116 retval
= jtag
->speed(cur_speed
);
2118 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2123 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2126 return ERROR_COMMAND_SYNTAX_ERROR
;
2128 int retval
= ERROR_OK
;
2132 LOG_DEBUG("handle jtag khz");
2134 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2137 LOG_DEBUG("have interface set up");
2139 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2140 if (ERROR_OK
!= retval
)
2142 jtag_set_speed_khz(0);
2145 cur_speed
= jtag_speed
= speed_div1
;
2147 retval
= jtag
->speed(cur_speed
);
2153 cur_speed
= jtag_get_speed_khz();
2156 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2157 if (ERROR_OK
!= retval
)
2162 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2164 command_print(cmd_ctx
, "RCLK - adaptive");
2169 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
2170 char *cmd
, char **args
, int argc
)
2173 return ERROR_COMMAND_SYNTAX_ERROR
;
2176 if (args
[0][0] == '1')
2178 else if (args
[0][0] == '0')
2181 return ERROR_COMMAND_SYNTAX_ERROR
;
2184 if (args
[1][0] == '1')
2186 else if (args
[1][0] == '0')
2189 return ERROR_COMMAND_SYNTAX_ERROR
;
2191 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2192 return ERROR_JTAG_INIT_FAILED
;
2194 jtag_add_reset(trst
, srst
);
2195 jtag_execute_queue();
2200 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
2201 char *cmd
, char **args
, int argc
)
2204 return ERROR_COMMAND_SYNTAX_ERROR
;
2206 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2207 jtag_execute_queue();
2213 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2214 * should be stable ... and *NOT* a shift state, otherwise free-running
2215 * jtag clocks could change the values latched by the update state.
2217 static bool scan_is_safe(tap_state_t state
)
2232 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2235 scan_field_t
*fields
;
2237 tap_state_t endstate
;
2239 if ((argc
< 2) || (argc
% 2))
2241 return ERROR_COMMAND_SYNTAX_ERROR
;
2244 /* optional "-endstate" "statename" at the end of the arguments,
2245 * so that e.g. IRPAUSE can let us load the data register before
2246 * entering RUN/IDLE to execute the instruction we load here.
2248 endstate
= TAP_IDLE
;
2251 /* have at least one pair of numbers. */
2252 /* is last pair the magic text? */
2253 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2256 cpA
= args
[ argc
-1 ];
2257 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2258 cpS
= tap_state_name( endstate
);
2259 if( 0 == strcmp( cpA
, cpS
) ){
2263 if( endstate
>= TAP_NUM_STATES
){
2264 return ERROR_COMMAND_SYNTAX_ERROR
;
2266 if (!scan_is_safe(endstate
))
2267 LOG_WARNING("irscan with unsafe "
2268 "endstate \"%s\"", cpA
);
2269 /* found - remove the last 2 args */
2275 int num_fields
= argc
/ 2;
2277 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2279 for (i
= 0; i
< num_fields
; i
++)
2281 tap
= jtag_tap_by_string( args
[i
*2] );
2284 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2287 int field_size
= tap
->ir_length
;
2288 fields
[i
].tap
= tap
;
2289 fields
[i
].num_bits
= field_size
;
2290 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2291 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2292 fields
[i
].in_value
= NULL
;
2295 /* did we have an endstate? */
2296 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2298 int retval
=jtag_execute_queue();
2300 for (i
= 0; i
< num_fields
; i
++)
2301 free(fields
[i
].out_value
);
2308 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2311 scan_field_t
*fields
;
2313 int field_count
= 0;
2316 tap_state_t endstate
;
2319 * args[2] = num_bits
2320 * args[3] = hex string
2321 * ... repeat num bits and hex string ...
2324 * args[N-2] = "-endstate"
2325 * args[N-1] = statename
2327 if ((argc
< 4) || ((argc
% 2)!=0))
2329 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2333 endstate
= TAP_IDLE
;
2335 /* validate arguments as numbers */
2337 for (i
= 2; i
< argc
; i
+=2)
2342 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2343 /* If valid - try next arg */
2348 /* Not valid.. are we at the end? */
2349 if ( ((i
+2) != argc
) ){
2350 /* nope, then error */
2354 /* it could be: "-endstate FOO"
2355 * e.g. DRPAUSE so we can issue more instructions
2356 * before entering RUN/IDLE and executing them.
2359 /* get arg as a string. */
2360 cp
= Jim_GetString( args
[i
], NULL
);
2361 /* is it the magic? */
2362 if( 0 == strcmp( "-endstate", cp
) ){
2363 /* is the statename valid? */
2364 cp
= Jim_GetString( args
[i
+1], NULL
);
2366 /* see if it is a valid state name */
2367 endstate
= tap_state_by_name(cp
);
2369 /* update the error message */
2370 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2372 if (!scan_is_safe(endstate
))
2373 LOG_WARNING("drscan with unsafe "
2374 "endstate \"%s\"", cp
);
2376 /* valid - so clear the error */
2378 /* and remove the last 2 args */
2383 /* Still an error? */
2385 return e
; /* too bad */
2387 } /* validate args */
2389 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2394 num_fields
=(argc
-2)/2;
2395 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2396 for (i
= 2; i
< argc
; i
+=2)
2402 Jim_GetLong(interp
, args
[i
], &bits
);
2403 str
= Jim_GetString(args
[i
+1], &len
);
2405 fields
[field_count
].tap
= tap
;
2406 fields
[field_count
].num_bits
= bits
;
2407 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2408 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2409 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2413 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2415 retval
= jtag_execute_queue();
2416 if (retval
!= ERROR_OK
)
2418 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2423 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2424 for (i
= 2; i
< argc
; i
+=2)
2429 Jim_GetLong(interp
, args
[i
], &bits
);
2430 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2431 free(fields
[field_count
].out_value
);
2433 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2438 Jim_SetResult(interp
, list
);
2446 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2448 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2454 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2458 if (strcmp(args
[0], "enable") == 0)
2460 jtag_verify_capture_ir
= 1;
2462 else if (strcmp(args
[0], "disable") == 0)
2464 jtag_verify_capture_ir
= 0;
2467 return ERROR_COMMAND_SYNTAX_ERROR
;
2469 } else if (argc
!= 0)
2471 return ERROR_COMMAND_SYNTAX_ERROR
;
2474 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2479 void jtag_set_verify(bool enable
)
2481 jtag_verify
= enable
;
2484 bool jtag_will_verify()
2489 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2492 return ERROR_COMMAND_SYNTAX_ERROR
;
2496 if (strcmp(args
[0], "enable") == 0)
2497 jtag_set_verify(true);
2498 else if (strcmp(args
[0], "disable") == 0)
2499 jtag_set_verify(false);
2501 return ERROR_COMMAND_SYNTAX_ERROR
;
2504 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2505 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2511 int jtag_power_dropout(int *dropout
)
2513 return jtag
->power_dropout(dropout
);
2516 int jtag_srst_asserted(int *srst_asserted
)
2518 return jtag
->srst_asserted(srst_asserted
);
2521 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2523 jtag_tap_event_action_t
* jteap
;
2526 jteap
= tap
->event_action
;
2530 if (jteap
->event
== e
) {
2532 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2535 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2536 Jim_GetString(jteap
->body
, NULL
) );
2537 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2538 Jim_PrintErrorMessage(interp
);
2542 jteap
= jteap
->next
;
2546 LOG_DEBUG( "event %d %s - no action",
2548 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2552 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2555 return ERROR_COMMAND_SYNTAX_ERROR
;
2560 if (strcmp(args
[0], "short") == 0)
2561 use_new_table
= true;
2562 else if (strcmp(args
[0], "long") == 0)
2563 use_new_table
= false;
2565 return ERROR_COMMAND_SYNTAX_ERROR
;
2567 tap_use_new_tms_table(use_new_table
);
2570 command_print(cmd_ctx
, "tms sequence is %s",
2571 tap_uses_new_tms_table() ? "short": "long");
2577 * Function jtag_add_statemove
2578 * moves from the current state to the goal \a state. This needs
2579 * to be handled according to the xsvf spec, see the XSTATE command
2582 int jtag_add_statemove(tap_state_t goal_state
)
2584 int retval
= ERROR_OK
;
2586 tap_state_t moves
[8];
2587 tap_state_t cur_state
= cmd_queue_cur_state
;
2592 LOG_DEBUG( "cur_state=%s goal_state=%s",
2593 tap_state_name(cur_state
),
2594 tap_state_name(goal_state
) );
2597 /* From the XSVF spec, pertaining to XSTATE:
2599 For special states known as stable states (Test-Logic-Reset,
2600 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2601 predefined TAP state paths when the starting state is a stable state and
2602 when the XSTATE specifies a new stable state (see the STATE command in
2603 the [Ref 5] for the TAP state paths between stable states). For
2604 non-stable states, XSTATE should specify a state that is only one TAP
2605 state transition distance from the current TAP state to avoid undefined
2606 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2607 transition the TAP through a specific state path.
2610 if (goal_state
==cur_state
)
2611 ; /* nothing to do */
2613 else if( goal_state
==TAP_RESET
)
2618 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2620 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2621 spec, then this code is not fully conformant to the xsvf spec. This
2622 puts a burden on tap_get_tms_path() function from the xsvf spec.
2623 If in doubt, you should confirm that that burden is being met.
2626 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2627 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2629 assert( (unsigned) tms_count
< DIM(moves
) );
2631 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2633 bool bit
= tms_bits
& 1;
2635 cur_state
= tap_state_transition(cur_state
, bit
);
2636 moves
[i
] = cur_state
;
2639 jtag_add_pathmove(tms_count
, moves
);
2642 /* else state must be immediately reachable in one clock cycle, and does not
2643 need to be a stable state.
2645 else if( tap_state_transition(cur_state
, true) == goal_state
2646 || tap_state_transition(cur_state
, false) == goal_state
)
2648 /* move a single state */
2649 moves
[0] = goal_state
;
2650 jtag_add_pathmove( 1, moves
);
2655 retval
= ERROR_FAIL
;
2661 void jtag_set_nsrst_delay(unsigned delay
)
2663 jtag_nsrst_delay
= delay
;
2665 unsigned jtag_get_nsrst_delay(void)
2667 return jtag_nsrst_delay
;
2669 void jtag_set_ntrst_delay(unsigned delay
)
2671 jtag_ntrst_delay
= delay
;
2673 unsigned jtag_get_ntrst_delay(void)
2675 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)