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
558 * For not bypassed TAPs the function checks in_fields and uses fields specified there.
559 * For bypassed TAPs the function generates a dummy 1bit field.
561 * The bypass status of TAPs is set by jtag_add_ir_scan().
564 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
570 retval
=interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
571 if (retval
!=ERROR_OK
)
578 * Duplicate the scan fields passed into the function into a DR SCAN command
580 * This function assumes that the caller handles extra fields for bypassed TAPs
583 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
589 retval
=interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
590 if (retval
!=ERROR_OK
)
594 void jtag_add_dr_out(jtag_tap_t
* tap
,
595 int num_fields
, const int* num_bits
, const u32
* value
,
596 tap_state_t end_state
)
598 assert(end_state
!= TAP_INVALID
);
600 cmd_queue_cur_state
= end_state
;
602 interface_jtag_add_dr_out(tap
,
603 num_fields
, num_bits
, value
,
607 void jtag_add_tlr(void)
609 jtag_prelude(TAP_RESET
);
612 retval
=interface_jtag_add_tlr();
613 if (retval
!=ERROR_OK
)
616 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
619 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
621 tap_state_t cur_state
= cmd_queue_cur_state
;
625 /* the last state has to be a stable state */
626 if (!tap_is_state_stable(path
[num_states
- 1]))
628 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
632 for (i
=0; i
<num_states
; i
++)
634 if (path
[i
] == TAP_RESET
)
636 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
640 if ( tap_state_transition(cur_state
, true) != path
[i
]
641 && tap_state_transition(cur_state
, false) != path
[i
])
643 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[i
]));
651 retval
= interface_jtag_add_pathmove(num_states
, path
);
652 cmd_queue_cur_state
= path
[num_states
- 1];
653 if (retval
!=ERROR_OK
)
657 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
663 /* executed by sw or hw fifo */
664 retval
=interface_jtag_add_runtest(num_cycles
, state
);
665 if (retval
!=ERROR_OK
)
670 void jtag_add_clocks( int num_cycles
)
674 if( !tap_is_state_stable(cmd_queue_cur_state
) )
676 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
677 tap_state_name(cmd_queue_cur_state
) );
678 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
686 retval
= interface_jtag_add_clocks(num_cycles
);
687 if (retval
!= ERROR_OK
)
692 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
694 int trst_with_tlr
= 0;
697 /* FIX!!! there are *many* different cases here. A better
698 * approach is needed for legal combinations of transitions...
700 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
701 (jtag_reset_config
& RESET_HAS_TRST
)&&
702 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
704 if (((req_tlr_or_trst
&&!jtag_trst
)||
705 (!req_tlr_or_trst
&&jtag_trst
))&&
706 ((req_srst
&&!jtag_srst
)||
707 (!req_srst
&&jtag_srst
)))
709 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
710 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
714 /* Make sure that jtag_reset_config allows the requested reset */
715 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
716 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
718 LOG_ERROR("BUG: requested reset would assert trst");
719 jtag_error
=ERROR_FAIL
;
723 /* if TRST pulls SRST, we reset with TAP T-L-R */
724 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
729 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
731 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
732 jtag_error
=ERROR_FAIL
;
738 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
750 jtag_srst
= req_srst
;
752 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
753 if (retval
!=ERROR_OK
)
758 jtag_execute_queue();
762 LOG_DEBUG("SRST line asserted");
766 LOG_DEBUG("SRST line released");
767 if (jtag_nsrst_delay
)
768 jtag_add_sleep(jtag_nsrst_delay
* 1000);
773 LOG_DEBUG("JTAG reset with RESET instead of TRST");
774 jtag_set_end_state(TAP_RESET
);
781 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
782 * and inform possible listeners about this
784 LOG_DEBUG("TRST line asserted");
785 tap_set_state(TAP_RESET
);
786 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
790 if (jtag_ntrst_delay
)
791 jtag_add_sleep(jtag_ntrst_delay
* 1000);
795 tap_state_t
jtag_set_end_state(tap_state_t state
)
797 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
799 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
802 if (state
!=TAP_INVALID
)
803 cmd_queue_end_state
= state
;
804 return cmd_queue_end_state
;
807 tap_state_t
jtag_get_end_state(void)
809 return cmd_queue_end_state
;
812 void jtag_add_sleep(u32 us
)
814 keep_alive(); /* we might be running on a very slow JTAG clk */
815 int retval
=interface_jtag_add_sleep(us
);
816 if (retval
!=ERROR_OK
)
821 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
823 int retval
= ERROR_OK
;
825 int compare_failed
= 0;
828 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
830 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
833 /* An error handler could have caught the failing check
834 * only report a problem when there wasn't a handler, or if the handler
835 * acknowledged the error
838 LOG_WARNING("TAP %s:",
839 jtag_tap_name(field->tap));
843 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
844 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
848 char *in_check_mask_char
;
849 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
850 LOG_WARNING("value captured during scan didn't pass the requested check:");
851 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
852 captured_char
, in_check_value_char
, in_check_mask_char
);
853 free(in_check_mask_char
);
857 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
);
861 free(in_check_value_char
);
863 retval
= ERROR_JTAG_QUEUE_FAILED
;
870 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
872 assert(field
->in_value
!= NULL
);
876 /* no checking to do */
880 jtag_execute_queue_noclear();
882 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
883 jtag_set_error(retval
);
888 int default_interface_jtag_execute_queue(void)
892 LOG_ERROR("No JTAG interface configured yet. "
893 "Issue 'init' command in startup scripts "
894 "before communicating with targets.");
898 return jtag
->execute_queue();
901 void jtag_execute_queue_noclear(void)
903 jtag_flush_queue_count
++;
904 jtag_set_error(interface_jtag_execute_queue());
907 int jtag_get_flush_queue_count(void)
909 return jtag_flush_queue_count
;
912 int jtag_execute_queue(void)
914 jtag_execute_queue_noclear();
915 return jtag_error_clear();
918 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
920 jtag_tap_t
*tap
= priv
;
924 if (event
== JTAG_TRST_ASSERTED
)
926 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
933 void jtag_sleep(u32 us
)
935 alive_sleep(us
/1000);
938 /// maximum number of JTAG devices expected in the chain
939 #define JTAG_MAX_CHAIN_SIZE 20
941 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
942 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
943 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
945 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
947 scan_field_t field
= {
949 .num_bits
= num_idcode
* 32,
950 .out_value
= idcode_buffer
,
951 .in_value
= idcode_buffer
,
954 // initialize to the end of chain ID value
955 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
956 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
958 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
959 return jtag_execute_queue();
962 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
967 for (unsigned i
= 0; i
< count
* 4; i
++)
969 zero_check
|= idcodes
[i
];
970 one_check
&= idcodes
[i
];
973 /* if there wasn't a single non-zero bit or if all bits were one,
974 * the scan is not valid */
975 if (zero_check
== 0x00 || one_check
== 0xff)
977 LOG_ERROR("JTAG communication failure: check connection, "
978 "JTAG interface, target power etc.");
984 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
985 const char *name
, u32 idcode
)
987 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
988 "JTAG tap: %s %16.16s: 0x%08x "
989 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
991 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
994 static bool jtag_idcode_is_final(u32 idcode
)
996 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
1000 * This helper checks that remaining bits in the examined chain data are
1001 * all as expected, but a single JTAG device requires only 64 bits to be
1002 * read back correctly. This can help identify and diagnose problems
1003 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1005 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
1007 bool triggered
= false;
1008 for ( ; count
< max
- 31; count
+= 32)
1010 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
1011 // do not trigger the warning if the data looks good
1012 if (!triggered
&& jtag_idcode_is_final(idcode
))
1014 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1020 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1022 if (0 == tap
->expected_ids_cnt
)
1024 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1026 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1027 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1032 /* Loop over the expected identification codes and test for a match */
1034 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1036 if (tap
->idcode
== tap
->expected_ids
[ii
])
1040 /* If none of the expected ids matched, log an error */
1041 if (ii
!= tap
->expected_ids_cnt
)
1043 LOG_INFO("JTAG Tap/device matched");
1046 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1047 tap
->dotted_name
, tap
->idcode
);
1048 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1051 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1052 ii
+ 1, tap
->expected_ids_cnt
);
1053 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1054 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1059 /* Try to examine chain layout according to IEEE 1149.1 §12
1061 static int jtag_examine_chain(void)
1063 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1064 unsigned device_count
= 0;
1066 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1068 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1069 return ERROR_JTAG_INIT_FAILED
;
1071 /* point at the 1st tap */
1072 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1075 LOG_ERROR("JTAG: No taps enabled?");
1076 return ERROR_JTAG_INIT_FAILED
;
1079 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1081 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1082 if ((idcode
& 1) == 0)
1084 /* LSB must not be 0, this indicates a device in bypass */
1085 LOG_WARNING("Tap/Device does not have IDCODE");
1093 * End of chain (invalid manufacturer ID) some devices, such
1094 * as AVR will output all 1's instead of TDI input value at
1097 if (jtag_idcode_is_final(idcode
))
1099 jtag_examine_chain_end(idcode_buffer
,
1100 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1104 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1105 tap
? tap
->dotted_name
: "(not-named)",
1114 tap
->idcode
= idcode
;
1116 // ensure the TAP ID does matches what was expected
1117 if (!jtag_examine_chain_match_tap(tap
))
1118 return ERROR_JTAG_INIT_FAILED
;
1120 tap
= jtag_tap_next_enabled(tap
);
1123 /* see if number of discovered devices matches configuration */
1124 if (device_count
!= jtag_tap_count_enabled())
1126 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1127 "does not match (enabled) configuration (%i), total taps: %d",
1128 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1129 LOG_ERROR("check the config file and ensure proper JTAG communication"
1130 " (connections, speed, ...)");
1131 return ERROR_JTAG_INIT_FAILED
;
1137 static int jtag_validate_chain(void)
1140 int total_ir_length
= 0;
1146 total_ir_length
= 0;
1148 tap
= jtag_tap_next_enabled(tap
);
1152 total_ir_length
+= tap
->ir_length
;
1155 total_ir_length
+= 2;
1156 ir_test
= malloc(CEIL(total_ir_length
, 8));
1157 buf_set_ones(ir_test
, total_ir_length
);
1160 field
.num_bits
= total_ir_length
;
1161 field
.out_value
= ir_test
;
1162 field
.in_value
= ir_test
;
1165 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1166 jtag_execute_queue();
1172 tap
= jtag_tap_next_enabled(tap
);
1177 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1180 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1181 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
);
1184 return ERROR_JTAG_INIT_FAILED
;
1186 chain_pos
+= tap
->ir_length
;
1189 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1192 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1193 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
);
1196 return ERROR_JTAG_INIT_FAILED
;
1204 enum jtag_tap_cfg_param
{
1208 static Jim_Nvp nvp_config_opts
[] = {
1209 { .name
= "-event", .value
= JCFG_EVENT
},
1211 { .name
= NULL
, .value
= -1 }
1214 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1220 /* parse config or cget options */
1221 while (goi
->argc
> 0) {
1222 Jim_SetEmptyResult (goi
->interp
);
1224 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1226 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1232 if (goi
->argc
== 0) {
1233 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1237 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1239 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1243 if (goi
->isconfigure
) {
1244 if (goi
->argc
!= 1) {
1245 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1249 if (goi
->argc
!= 0) {
1250 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1256 jtag_tap_event_action_t
*jteap
;
1258 jteap
= tap
->event_action
;
1259 /* replace existing? */
1261 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1264 jteap
= jteap
->next
;
1267 if (goi
->isconfigure
) {
1268 if (jteap
== NULL
) {
1270 jteap
= calloc(1, sizeof (*jteap
));
1272 jteap
->event
= n
->value
;
1273 Jim_GetOpt_Obj( goi
, &o
);
1275 Jim_DecrRefCount(interp
, jteap
->body
);
1277 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1278 Jim_IncrRefCount(jteap
->body
);
1280 /* add to head of event list */
1281 jteap
->next
= tap
->event_action
;
1282 tap
->event_action
= jteap
;
1283 Jim_SetEmptyResult(goi
->interp
);
1286 if (jteap
== NULL
) {
1287 Jim_SetEmptyResult(goi
->interp
);
1289 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1296 } /* while (goi->argc) */
1302 static void jtag_tap_init(jtag_tap_t
*tap
)
1304 assert(0 != tap
->ir_length
);
1306 tap
->expected
= malloc(tap
->ir_length
);
1307 tap
->expected_mask
= malloc(tap
->ir_length
);
1308 tap
->cur_instr
= malloc(tap
->ir_length
);
1310 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1311 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1312 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1314 // place TAP in bypass mode
1316 // register the reset callback for the TAP
1317 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1319 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1320 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1321 tap
->abs_chain_position
, tap
->ir_length
,
1322 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1326 static void jtag_tap_free(jtag_tap_t
*tap
)
1328 /// @todo is anything missing? no memory leaks please
1329 free((void *)tap
->expected_ids
);
1330 free((void *)tap
->chip
);
1331 free((void *)tap
->tapname
);
1332 free((void *)tap
->dotted_name
);
1336 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1345 const Jim_Nvp opts
[] = {
1346 #define NTAP_OPT_IRLEN 0
1347 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1348 #define NTAP_OPT_IRMASK 1
1349 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1350 #define NTAP_OPT_IRCAPTURE 2
1351 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1352 #define NTAP_OPT_ENABLED 3
1353 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1354 #define NTAP_OPT_DISABLED 4
1355 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1356 #define NTAP_OPT_EXPECTED_ID 5
1357 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1358 { .name
= NULL
, .value
= -1 },
1361 pTap
= malloc( sizeof(jtag_tap_t
) );
1362 memset( pTap
, 0, sizeof(*pTap
) );
1364 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1368 * we expect CHIP + TAP + OPTIONS
1370 if( goi
->argc
< 3 ){
1371 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1374 Jim_GetOpt_String( goi
, &cp
, NULL
);
1375 pTap
->chip
= strdup(cp
);
1377 Jim_GetOpt_String( goi
, &cp
, NULL
);
1378 pTap
->tapname
= strdup(cp
);
1380 /* name + dot + name + null */
1381 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1383 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1384 pTap
->dotted_name
= cp
;
1386 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1387 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1389 /* default is enabled */
1392 /* deal with options */
1393 #define NTREQ_IRLEN 1
1394 #define NTREQ_IRCAPTURE 2
1395 #define NTREQ_IRMASK 4
1397 /* clear them as we find them */
1398 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1401 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1403 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1406 LOG_DEBUG("Processing option: %s", n
->name
);
1408 case NTAP_OPT_ENABLED
:
1411 case NTAP_OPT_DISABLED
:
1414 case NTAP_OPT_EXPECTED_ID
:
1416 u32
*new_expected_ids
;
1418 e
= Jim_GetOpt_Wide( goi
, &w
);
1420 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1424 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1425 if (new_expected_ids
== NULL
) {
1426 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1430 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1432 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1434 free(pTap
->expected_ids
);
1435 pTap
->expected_ids
= new_expected_ids
;
1436 pTap
->expected_ids_cnt
++;
1439 case NTAP_OPT_IRLEN
:
1440 case NTAP_OPT_IRMASK
:
1441 case NTAP_OPT_IRCAPTURE
:
1442 e
= Jim_GetOpt_Wide( goi
, &w
);
1444 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1447 if( (w
< 0) || (w
> 0xffff) ){
1449 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1450 n
->name
, (int)(w
), (int)(w
));
1454 case NTAP_OPT_IRLEN
:
1455 pTap
->ir_length
= w
;
1456 reqbits
&= (~(NTREQ_IRLEN
));
1458 case NTAP_OPT_IRMASK
:
1459 pTap
->ir_capture_mask
= w
;
1460 reqbits
&= (~(NTREQ_IRMASK
));
1462 case NTAP_OPT_IRCAPTURE
:
1463 pTap
->ir_capture_value
= w
;
1464 reqbits
&= (~(NTREQ_IRCAPTURE
));
1467 } /* switch(n->value) */
1468 } /* while( goi->argc ) */
1470 /* Did all the required option bits get cleared? */
1473 jtag_tap_init(pTap
);
1477 Jim_SetResult_sprintf(goi
->interp
,
1478 "newtap: %s missing required parameters",
1480 jtag_tap_free(pTap
);
1484 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1490 struct command_context_s
*context
;
1494 JTAG_CMD_INIT_RESET
,
1497 JTAG_CMD_TAPDISABLE
,
1498 JTAG_CMD_TAPISENABLED
,
1503 const Jim_Nvp jtag_cmds
[] = {
1504 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1505 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1506 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1507 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1508 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1509 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1510 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1511 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1513 { .name
= NULL
, .value
= -1 },
1516 context
= Jim_GetAssocData(interp
, "context");
1517 /* go past the command */
1518 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1520 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1522 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1525 Jim_SetEmptyResult( goi
.interp
);
1527 case JTAG_CMD_INTERFACE
:
1528 /* return the name of the interface */
1529 /* TCL code might need to know the exact type... */
1530 /* FUTURE: we allow this as a means to "set" the interface. */
1531 if( goi
.argc
!= 0 ){
1532 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1535 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1537 case JTAG_CMD_INIT_RESET
:
1538 if( goi
.argc
!= 0 ){
1539 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1542 e
= jtag_init_reset(context
);
1543 if( e
!= ERROR_OK
){
1544 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1548 case JTAG_CMD_NEWTAP
:
1549 return jim_newtap_cmd( &goi
);
1551 case JTAG_CMD_TAPISENABLED
:
1552 case JTAG_CMD_TAPENABLE
:
1553 case JTAG_CMD_TAPDISABLE
:
1554 if( goi
.argc
!= 1 ){
1555 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1561 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1566 case JTAG_CMD_TAPISENABLED
:
1569 case JTAG_CMD_TAPENABLE
:
1570 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1574 case JTAG_CMD_TAPDISABLE
:
1575 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1580 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1587 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1594 Jim_GetOpt_Obj(&goi
, &o
);
1595 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1600 goi
.isconfigure
= 0;
1601 return jtag_tap_configure_cmd( &goi
, t
);
1605 case JTAG_CMD_CONFIGURE
:
1607 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1614 Jim_GetOpt_Obj(&goi
, &o
);
1615 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1620 goi
.isconfigure
= 1;
1621 return jtag_tap_configure_cmd( &goi
, t
);
1628 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1630 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1632 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1633 COMMAND_CONFIG
, "try to configure interface");
1634 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1635 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1636 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1637 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1638 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1639 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1640 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1641 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1643 "[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]");
1644 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1645 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1646 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1647 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1649 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1650 COMMAND_EXEC
, "print current scan chain configuration");
1652 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1653 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1654 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1655 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1656 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1657 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1658 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1659 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1661 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1662 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1663 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1664 COMMAND_ANY
, "verify value capture <enable|disable>");
1665 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1666 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1670 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1675 if (!jtag_interface
)
1677 /* nothing was previously specified by "interface" command */
1678 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1679 return ERROR_JTAG_INVALID_INTERFACE
;
1683 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1687 if (jtag_interface
->init() != ERROR_OK
)
1688 return ERROR_JTAG_INIT_FAILED
;
1690 jtag
= jtag_interface
;
1694 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1699 LOG_DEBUG("Init JTAG chain");
1701 tap
= jtag_tap_next_enabled(NULL
);
1703 LOG_ERROR("There are no enabled taps?");
1704 return ERROR_JTAG_INIT_FAILED
;
1708 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1711 /* examine chain first, as this could discover the real chain layout */
1712 if (jtag_examine_chain() != ERROR_OK
)
1714 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1717 if (jtag_validate_chain() != ERROR_OK
)
1719 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1725 int jtag_interface_quit(void)
1727 if (!jtag
|| !jtag
->quit
)
1730 // close the JTAG interface
1731 int result
= jtag
->quit();
1732 if (ERROR_OK
!= result
)
1733 LOG_ERROR("failed: %d", result
);
1739 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1743 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1746 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1748 /* Reset can happen after a power cycle.
1750 * Ideally we would only assert TRST or run RESET before the target reset.
1752 * However w/srst_pulls_trst, trst is asserted together with the target
1753 * reset whether we want it or not.
1755 * NB! Some targets have JTAG circuitry disabled until a
1756 * trst & srst has been asserted.
1758 * NB! here we assume nsrst/ntrst delay are sufficient!
1760 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1763 jtag_add_reset(1, 0); /* RESET or TRST */
1764 if (jtag_reset_config
& RESET_HAS_SRST
)
1766 jtag_add_reset(1, 1);
1767 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1768 jtag_add_reset(0, 1);
1770 jtag_add_reset(0, 0);
1771 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1774 /* Check that we can communication on the JTAG chain + eventually we want to
1775 * be able to perform enumeration only after OpenOCD has started
1776 * telnet and GDB server
1778 * That would allow users to more easily perform any magic they need to before
1781 return jtag_init_inner(cmd_ctx
);
1784 int jtag_init(struct command_context_s
*cmd_ctx
)
1787 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1789 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1793 return jtag_init_reset(cmd_ctx
);
1796 void jtag_set_speed_khz(unsigned khz
)
1800 unsigned jtag_get_speed_khz(void)
1805 static int default_khz(int khz
, int *jtag_speed
)
1807 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1811 static int default_speed_div(int speed
, int *khz
)
1813 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1817 static int default_power_dropout(int *dropout
)
1819 *dropout
=0; /* by default we can't detect power dropout */
1823 static int default_srst_asserted(int *srst_asserted
)
1825 *srst_asserted
=0; /* by default we can't detect srst asserted */
1829 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1834 /* check whether the interface is already configured */
1837 LOG_WARNING("Interface already configured, ignoring");
1841 /* interface name is a mandatory argument */
1842 if (argc
< 1 || args
[0][0] == '\0')
1844 return ERROR_COMMAND_SYNTAX_ERROR
;
1847 for (i
=0; jtag_interfaces
[i
]; i
++)
1849 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1851 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1856 jtag_interface
= jtag_interfaces
[i
];
1858 if (jtag_interface
->khz
== NULL
)
1860 jtag_interface
->khz
= default_khz
;
1862 if (jtag_interface
->speed_div
== NULL
)
1864 jtag_interface
->speed_div
= default_speed_div
;
1866 if (jtag_interface
->power_dropout
== NULL
)
1868 jtag_interface
->power_dropout
= default_power_dropout
;
1870 if (jtag_interface
->srst_asserted
== NULL
)
1872 jtag_interface
->srst_asserted
= default_srst_asserted
;
1879 /* no valid interface was found (i.e. the configuration option,
1880 * didn't match one of the compiled-in interfaces
1882 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1883 LOG_ERROR("compiled-in jtag interfaces:");
1884 for (i
= 0; jtag_interfaces
[i
]; i
++)
1886 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1889 return ERROR_JTAG_INVALID_INTERFACE
;
1892 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1896 Jim_Obj
*newargs
[ 10 ];
1899 * argv[-1] = command
1900 * argv[ 0] = ir length
1901 * argv[ 1] = ir capture
1902 * argv[ 2] = ir mask
1903 * argv[ 3] = not actually used by anything but in the docs
1907 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1910 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1911 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1915 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1916 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1917 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1918 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1920 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1921 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1922 sprintf( buf
, "chip%d", jtag_tap_count() );
1923 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1924 sprintf( buf
, "tap%d", jtag_tap_count() );
1925 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1926 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1927 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1928 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1929 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1930 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1931 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1933 command_print( cmd_ctx
, "NEW COMMAND:");
1934 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1935 Jim_GetString( newargs
[0], NULL
),
1936 Jim_GetString( newargs
[1], NULL
),
1937 Jim_GetString( newargs
[2], NULL
),
1938 Jim_GetString( newargs
[3], NULL
),
1939 Jim_GetString( newargs
[4], NULL
),
1940 Jim_GetString( newargs
[5], NULL
),
1941 Jim_GetString( newargs
[6], NULL
),
1942 Jim_GetString( newargs
[7], NULL
),
1943 Jim_GetString( newargs
[8], NULL
),
1944 Jim_GetString( newargs
[9], NULL
) );
1946 e
= jim_jtag_command( interp
, 10, newargs
);
1948 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1953 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1957 tap
= jtag_all_taps();
1958 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1959 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1962 u32 expected
, expected_mask
, cur_instr
, ii
;
1963 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1964 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1965 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1967 command_print(cmd_ctx
,
1968 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1969 tap
->abs_chain_position
,
1971 tap
->enabled
? 'Y' : 'n',
1973 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1979 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1980 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1981 tap
->expected_ids
[ii
]);
1984 tap
= tap
->next_tap
;
1990 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1996 return ERROR_COMMAND_SYNTAX_ERROR
;
1998 /* Original versions cared about the order of these tokens:
1999 * reset_config signals [combination [trst_type [srst_type]]]
2000 * They also clobbered the previous configuration even on error.
2002 * Here we don't care about the order, and only change values
2003 * which have been explicitly specified.
2005 for (; argc
; argc
--, args
++) {
2010 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2011 if (strcmp(*args
, "none") == 0)
2013 else if (strcmp(*args
, "trst_only") == 0)
2014 tmp
= RESET_HAS_TRST
;
2015 else if (strcmp(*args
, "srst_only") == 0)
2016 tmp
= RESET_HAS_SRST
;
2017 else if (strcmp(*args
, "trst_and_srst") == 0)
2018 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2022 LOG_ERROR("extra reset_config %s spec (%s)",
2024 return ERROR_INVALID_ARGUMENTS
;
2029 /* combination (options for broken wiring) */
2030 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2031 if (strcmp(*args
, "separate") == 0)
2032 /* separate reset lines - default */;
2033 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2034 tmp
|= RESET_SRST_PULLS_TRST
;
2035 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2036 tmp
|= RESET_TRST_PULLS_SRST
;
2037 else if (strcmp(*args
, "combined") == 0)
2038 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2042 LOG_ERROR("extra reset_config %s spec (%s)",
2043 "combination", *args
);
2044 return ERROR_INVALID_ARGUMENTS
;
2049 /* trst_type (NOP without HAS_TRST) */
2050 m
= RESET_TRST_OPEN_DRAIN
;
2051 if (strcmp(*args
, "trst_open_drain") == 0)
2052 tmp
|= RESET_TRST_OPEN_DRAIN
;
2053 else if (strcmp(*args
, "trst_push_pull") == 0)
2054 /* push/pull from adapter - default */;
2058 LOG_ERROR("extra reset_config %s spec (%s)",
2059 "trst_type", *args
);
2060 return ERROR_INVALID_ARGUMENTS
;
2065 /* srst_type (NOP without HAS_SRST) */
2066 m
|= RESET_SRST_PUSH_PULL
;
2067 if (strcmp(*args
, "srst_push_pull") == 0)
2068 tmp
|= RESET_SRST_PUSH_PULL
;
2069 else if (strcmp(*args
, "srst_open_drain") == 0)
2070 /* open drain from adapter - default */;
2074 LOG_ERROR("extra reset_config %s spec (%s)",
2075 "srst_type", *args
);
2076 return ERROR_INVALID_ARGUMENTS
;
2081 /* caller provided nonsense; fail */
2082 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2083 return ERROR_INVALID_ARGUMENTS
;
2086 /* Remember the bits which were specified (mask)
2087 * and their new values (new_cfg).
2093 /* clear previous values of those bits, save new values */
2094 jtag_reset_config
&= ~mask
;
2095 jtag_reset_config
|= new_cfg
;
2100 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2101 char *cmd
, char **args
, int argc
)
2104 return ERROR_COMMAND_SYNTAX_ERROR
;
2106 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2107 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2111 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2112 char *cmd
, char **args
, int argc
)
2115 return ERROR_COMMAND_SYNTAX_ERROR
;
2117 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2118 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2122 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2124 int retval
= ERROR_OK
;
2127 return ERROR_COMMAND_SYNTAX_ERROR
;
2130 LOG_DEBUG("handle jtag speed");
2133 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2135 /* this command can be called during CONFIG,
2136 * in which case jtag isn't initialized */
2138 retval
= jtag
->speed(cur_speed
);
2140 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2145 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2148 return ERROR_COMMAND_SYNTAX_ERROR
;
2150 int retval
= ERROR_OK
;
2154 LOG_DEBUG("handle jtag khz");
2156 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2159 LOG_DEBUG("have interface set up");
2161 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2162 if (ERROR_OK
!= retval
)
2164 jtag_set_speed_khz(0);
2167 cur_speed
= jtag_speed
= speed_div1
;
2169 retval
= jtag
->speed(cur_speed
);
2175 cur_speed
= jtag_get_speed_khz();
2178 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2179 if (ERROR_OK
!= retval
)
2184 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2186 command_print(cmd_ctx
, "RCLK - adaptive");
2191 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
2192 char *cmd
, char **args
, int argc
)
2195 return ERROR_COMMAND_SYNTAX_ERROR
;
2198 if (args
[0][0] == '1')
2200 else if (args
[0][0] == '0')
2203 return ERROR_COMMAND_SYNTAX_ERROR
;
2206 if (args
[1][0] == '1')
2208 else if (args
[1][0] == '0')
2211 return ERROR_COMMAND_SYNTAX_ERROR
;
2213 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2214 return ERROR_JTAG_INIT_FAILED
;
2216 jtag_add_reset(trst
, srst
);
2217 jtag_execute_queue();
2222 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
2223 char *cmd
, char **args
, int argc
)
2226 return ERROR_COMMAND_SYNTAX_ERROR
;
2228 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2229 jtag_execute_queue();
2235 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2236 * should be stable ... and *NOT* a shift state, otherwise free-running
2237 * jtag clocks could change the values latched by the update state.
2239 static bool scan_is_safe(tap_state_t state
)
2254 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2257 scan_field_t
*fields
;
2259 tap_state_t endstate
;
2261 if ((argc
< 2) || (argc
% 2))
2263 return ERROR_COMMAND_SYNTAX_ERROR
;
2266 /* optional "-endstate" "statename" at the end of the arguments,
2267 * so that e.g. IRPAUSE can let us load the data register before
2268 * entering RUN/IDLE to execute the instruction we load here.
2270 endstate
= TAP_IDLE
;
2273 /* have at least one pair of numbers. */
2274 /* is last pair the magic text? */
2275 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2278 cpA
= args
[ argc
-1 ];
2279 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2280 cpS
= tap_state_name( endstate
);
2281 if( 0 == strcmp( cpA
, cpS
) ){
2285 if( endstate
>= TAP_NUM_STATES
){
2286 return ERROR_COMMAND_SYNTAX_ERROR
;
2288 if (!scan_is_safe(endstate
))
2289 LOG_WARNING("irscan with unsafe "
2290 "endstate \"%s\"", cpA
);
2291 /* found - remove the last 2 args */
2297 int num_fields
= argc
/ 2;
2299 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2301 for (i
= 0; i
< num_fields
; i
++)
2303 tap
= jtag_tap_by_string( args
[i
*2] );
2306 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2309 int field_size
= tap
->ir_length
;
2310 fields
[i
].tap
= tap
;
2311 fields
[i
].num_bits
= field_size
;
2312 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2313 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2314 fields
[i
].in_value
= NULL
;
2317 /* did we have an endstate? */
2318 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2320 int retval
=jtag_execute_queue();
2322 for (i
= 0; i
< num_fields
; i
++)
2323 free(fields
[i
].out_value
);
2330 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2333 scan_field_t
*fields
;
2335 int field_count
= 0;
2338 tap_state_t endstate
;
2341 * args[2] = num_bits
2342 * args[3] = hex string
2343 * ... repeat num bits and hex string ...
2346 * args[N-2] = "-endstate"
2347 * args[N-1] = statename
2349 if ((argc
< 4) || ((argc
% 2)!=0))
2351 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2355 endstate
= TAP_IDLE
;
2357 /* validate arguments as numbers */
2359 for (i
= 2; i
< argc
; i
+=2)
2364 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2365 /* If valid - try next arg */
2370 /* Not valid.. are we at the end? */
2371 if ( ((i
+2) != argc
) ){
2372 /* nope, then error */
2376 /* it could be: "-endstate FOO"
2377 * e.g. DRPAUSE so we can issue more instructions
2378 * before entering RUN/IDLE and executing them.
2381 /* get arg as a string. */
2382 cp
= Jim_GetString( args
[i
], NULL
);
2383 /* is it the magic? */
2384 if( 0 == strcmp( "-endstate", cp
) ){
2385 /* is the statename valid? */
2386 cp
= Jim_GetString( args
[i
+1], NULL
);
2388 /* see if it is a valid state name */
2389 endstate
= tap_state_by_name(cp
);
2391 /* update the error message */
2392 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2394 if (!scan_is_safe(endstate
))
2395 LOG_WARNING("drscan with unsafe "
2396 "endstate \"%s\"", cp
);
2398 /* valid - so clear the error */
2400 /* and remove the last 2 args */
2405 /* Still an error? */
2407 return e
; /* too bad */
2409 } /* validate args */
2411 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2416 num_fields
=(argc
-2)/2;
2417 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2418 for (i
= 2; i
< argc
; i
+=2)
2424 Jim_GetLong(interp
, args
[i
], &bits
);
2425 str
= Jim_GetString(args
[i
+1], &len
);
2427 fields
[field_count
].tap
= tap
;
2428 fields
[field_count
].num_bits
= bits
;
2429 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2430 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2431 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2435 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2437 retval
= jtag_execute_queue();
2438 if (retval
!= ERROR_OK
)
2440 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2445 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2446 for (i
= 2; i
< argc
; i
+=2)
2451 Jim_GetLong(interp
, args
[i
], &bits
);
2452 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2453 free(fields
[field_count
].out_value
);
2455 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2460 Jim_SetResult(interp
, list
);
2468 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2470 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2476 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2480 if (strcmp(args
[0], "enable") == 0)
2482 jtag_verify_capture_ir
= 1;
2484 else if (strcmp(args
[0], "disable") == 0)
2486 jtag_verify_capture_ir
= 0;
2489 return ERROR_COMMAND_SYNTAX_ERROR
;
2491 } else if (argc
!= 0)
2493 return ERROR_COMMAND_SYNTAX_ERROR
;
2496 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2501 void jtag_set_verify(bool enable
)
2503 jtag_verify
= enable
;
2506 bool jtag_will_verify()
2511 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2514 return ERROR_COMMAND_SYNTAX_ERROR
;
2518 if (strcmp(args
[0], "enable") == 0)
2519 jtag_set_verify(true);
2520 else if (strcmp(args
[0], "disable") == 0)
2521 jtag_set_verify(false);
2523 return ERROR_COMMAND_SYNTAX_ERROR
;
2526 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2527 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2533 int jtag_power_dropout(int *dropout
)
2535 return jtag
->power_dropout(dropout
);
2538 int jtag_srst_asserted(int *srst_asserted
)
2540 return jtag
->srst_asserted(srst_asserted
);
2543 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2545 jtag_tap_event_action_t
* jteap
;
2548 jteap
= tap
->event_action
;
2552 if (jteap
->event
== e
) {
2554 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2557 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2558 Jim_GetString(jteap
->body
, NULL
) );
2559 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2560 Jim_PrintErrorMessage(interp
);
2564 jteap
= jteap
->next
;
2568 LOG_DEBUG( "event %d %s - no action",
2570 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2574 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2577 return ERROR_COMMAND_SYNTAX_ERROR
;
2582 if (strcmp(args
[0], "short") == 0)
2583 use_new_table
= true;
2584 else if (strcmp(args
[0], "long") == 0)
2585 use_new_table
= false;
2587 return ERROR_COMMAND_SYNTAX_ERROR
;
2589 tap_use_new_tms_table(use_new_table
);
2592 command_print(cmd_ctx
, "tms sequence is %s",
2593 tap_uses_new_tms_table() ? "short": "long");
2599 * Function jtag_add_statemove
2600 * moves from the current state to the goal \a state. This needs
2601 * to be handled according to the xsvf spec, see the XSTATE command
2604 int jtag_add_statemove(tap_state_t goal_state
)
2606 int retval
= ERROR_OK
;
2608 tap_state_t moves
[8];
2609 tap_state_t cur_state
= cmd_queue_cur_state
;
2614 LOG_DEBUG( "cur_state=%s goal_state=%s",
2615 tap_state_name(cur_state
),
2616 tap_state_name(goal_state
) );
2619 /* From the XSVF spec, pertaining to XSTATE:
2621 For special states known as stable states (Test-Logic-Reset,
2622 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2623 predefined TAP state paths when the starting state is a stable state and
2624 when the XSTATE specifies a new stable state (see the STATE command in
2625 the [Ref 5] for the TAP state paths between stable states). For
2626 non-stable states, XSTATE should specify a state that is only one TAP
2627 state transition distance from the current TAP state to avoid undefined
2628 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2629 transition the TAP through a specific state path.
2632 if (goal_state
==cur_state
)
2633 ; /* nothing to do */
2635 else if( goal_state
==TAP_RESET
)
2640 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2642 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2643 spec, then this code is not fully conformant to the xsvf spec. This
2644 puts a burden on tap_get_tms_path() function from the xsvf spec.
2645 If in doubt, you should confirm that that burden is being met.
2648 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2649 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2651 assert( (unsigned) tms_count
< DIM(moves
) );
2653 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2655 bool bit
= tms_bits
& 1;
2657 cur_state
= tap_state_transition(cur_state
, bit
);
2658 moves
[i
] = cur_state
;
2661 jtag_add_pathmove(tms_count
, moves
);
2664 /* else state must be immediately reachable in one clock cycle, and does not
2665 need to be a stable state.
2667 else if( tap_state_transition(cur_state
, true) == goal_state
2668 || tap_state_transition(cur_state
, false) == goal_state
)
2670 /* move a single state */
2671 moves
[0] = goal_state
;
2672 jtag_add_pathmove( 1, moves
);
2677 retval
= ERROR_FAIL
;
2683 void jtag_set_nsrst_delay(unsigned delay
)
2685 jtag_nsrst_delay
= delay
;
2687 unsigned jtag_get_nsrst_delay(void)
2689 return jtag_nsrst_delay
;
2691 void jtag_set_ntrst_delay(unsigned delay
)
2693 jtag_ntrst_delay
= delay
;
2695 unsigned jtag_get_ntrst_delay(void)
2697 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)