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
, tap_state_t state
)
483 retval
=interface_jtag_add_plain_ir_scan(in_num_fields
, in_fields
, state
);
484 if (retval
!=ERROR_OK
)
488 void jtag_add_callback(jtag_callback1_t f
, u8
*in
)
490 interface_jtag_add_callback(f
, in
);
493 void jtag_add_callback4(jtag_callback_t f
, u8
*in
,
494 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
495 jtag_callback_data_t data3
)
497 interface_jtag_add_callback4(f
, in
, data1
, data2
, data3
);
500 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
);
502 static int jtag_check_value_mask_callback(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
504 return jtag_check_value_inner(in
, (u8
*)data1
, (u8
*)data2
, (int)data3
);
507 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
508 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
510 for (int i
= 0; i
< in_num_fields
; i
++)
512 struct scan_field_s
*field
= &in_fields
[i
];
513 field
->allocated
= 0;
515 if (field
->check_value
|| field
->in_value
)
517 interface_jtag_add_scan_check_alloc(field
);
521 jtag_add_scan(in_num_fields
, in_fields
, state
);
523 for (int i
= 0; i
< in_num_fields
; i
++)
525 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
527 /* this is synchronous for a minidriver */
528 jtag_add_callback4(jtag_check_value_mask_callback
, in_fields
[i
].in_value
,
529 (jtag_callback_data_t
)in_fields
[i
].check_value
,
530 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
531 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
533 if (in_fields
[i
].allocated
)
535 free(in_fields
[i
].in_value
);
537 if (in_fields
[i
].modified
)
539 in_fields
[i
].in_value
= NULL
;
544 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
548 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
551 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
557 * Generate a DR SCAN using the fields passed to the function
559 * For not bypassed TAPs the function checks in_fields and uses fields specified there.
560 * For bypassed TAPs the function generates a dummy 1bit field.
562 * The bypass status of TAPs is set by jtag_add_ir_scan().
565 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
571 retval
=interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
572 if (retval
!=ERROR_OK
)
579 * Duplicate the scan fields passed into the function into a DR SCAN command
581 * This function assumes that the caller handles extra fields for bypassed TAPs
584 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
590 retval
=interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
591 if (retval
!=ERROR_OK
)
595 void jtag_add_dr_out(jtag_tap_t
* tap
,
596 int num_fields
, const int* num_bits
, const u32
* value
,
597 tap_state_t end_state
)
599 assert(end_state
!= TAP_INVALID
);
601 cmd_queue_cur_state
= end_state
;
603 interface_jtag_add_dr_out(tap
,
604 num_fields
, num_bits
, value
,
608 void jtag_add_tlr(void)
610 jtag_prelude(TAP_RESET
);
613 retval
=interface_jtag_add_tlr();
614 if (retval
!=ERROR_OK
)
617 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
620 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
622 tap_state_t cur_state
= cmd_queue_cur_state
;
626 /* the last state has to be a stable state */
627 if (!tap_is_state_stable(path
[num_states
- 1]))
629 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
633 for (i
=0; i
<num_states
; i
++)
635 if (path
[i
] == TAP_RESET
)
637 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
641 if ( tap_state_transition(cur_state
, true) != path
[i
]
642 && tap_state_transition(cur_state
, false) != path
[i
])
644 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[i
]));
652 retval
= interface_jtag_add_pathmove(num_states
, path
);
653 cmd_queue_cur_state
= path
[num_states
- 1];
654 if (retval
!=ERROR_OK
)
658 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
664 /* executed by sw or hw fifo */
665 retval
=interface_jtag_add_runtest(num_cycles
, state
);
666 if (retval
!=ERROR_OK
)
671 void jtag_add_clocks( int num_cycles
)
675 if( !tap_is_state_stable(cmd_queue_cur_state
) )
677 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
678 tap_state_name(cmd_queue_cur_state
) );
679 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
687 retval
= interface_jtag_add_clocks(num_cycles
);
688 if (retval
!= ERROR_OK
)
693 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
695 int trst_with_tlr
= 0;
698 /* FIX!!! there are *many* different cases here. A better
699 * approach is needed for legal combinations of transitions...
701 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
702 (jtag_reset_config
& RESET_HAS_TRST
)&&
703 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
705 if (((req_tlr_or_trst
&&!jtag_trst
)||
706 (!req_tlr_or_trst
&&jtag_trst
))&&
707 ((req_srst
&&!jtag_srst
)||
708 (!req_srst
&&jtag_srst
)))
710 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
711 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
715 /* Make sure that jtag_reset_config allows the requested reset */
716 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
717 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
719 LOG_ERROR("BUG: requested reset would assert trst");
720 jtag_error
=ERROR_FAIL
;
724 /* if TRST pulls SRST, we reset with TAP T-L-R */
725 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
730 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
732 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
733 jtag_error
=ERROR_FAIL
;
739 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
751 jtag_srst
= req_srst
;
753 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
754 if (retval
!=ERROR_OK
)
759 jtag_execute_queue();
763 LOG_DEBUG("SRST line asserted");
767 LOG_DEBUG("SRST line released");
768 if (jtag_nsrst_delay
)
769 jtag_add_sleep(jtag_nsrst_delay
* 1000);
774 LOG_DEBUG("JTAG reset with RESET instead of TRST");
775 jtag_set_end_state(TAP_RESET
);
782 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
783 * and inform possible listeners about this
785 LOG_DEBUG("TRST line asserted");
786 tap_set_state(TAP_RESET
);
787 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
791 if (jtag_ntrst_delay
)
792 jtag_add_sleep(jtag_ntrst_delay
* 1000);
796 tap_state_t
jtag_set_end_state(tap_state_t state
)
798 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
800 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
803 if (state
!=TAP_INVALID
)
804 cmd_queue_end_state
= state
;
805 return cmd_queue_end_state
;
808 tap_state_t
jtag_get_end_state(void)
810 return cmd_queue_end_state
;
813 void jtag_add_sleep(u32 us
)
815 keep_alive(); /* we might be running on a very slow JTAG clk */
816 int retval
=interface_jtag_add_sleep(us
);
817 if (retval
!=ERROR_OK
)
822 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
824 int retval
= ERROR_OK
;
826 int compare_failed
= 0;
829 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
831 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
834 /* An error handler could have caught the failing check
835 * only report a problem when there wasn't a handler, or if the handler
836 * acknowledged the error
839 LOG_WARNING("TAP %s:",
840 jtag_tap_name(field->tap));
844 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
845 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
849 char *in_check_mask_char
;
850 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
851 LOG_WARNING("value captured during scan didn't pass the requested check:");
852 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
853 captured_char
, in_check_value_char
, in_check_mask_char
);
854 free(in_check_mask_char
);
858 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
);
862 free(in_check_value_char
);
864 retval
= ERROR_JTAG_QUEUE_FAILED
;
871 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
873 assert(field
->in_value
!= NULL
);
877 /* no checking to do */
881 jtag_execute_queue_noclear();
883 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
884 jtag_set_error(retval
);
889 int default_interface_jtag_execute_queue(void)
893 LOG_ERROR("No JTAG interface configured yet. "
894 "Issue 'init' command in startup scripts "
895 "before communicating with targets.");
899 return jtag
->execute_queue();
902 void jtag_execute_queue_noclear(void)
904 jtag_flush_queue_count
++;
905 jtag_set_error(interface_jtag_execute_queue());
908 int jtag_get_flush_queue_count(void)
910 return jtag_flush_queue_count
;
913 int jtag_execute_queue(void)
915 jtag_execute_queue_noclear();
916 return jtag_error_clear();
919 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
921 jtag_tap_t
*tap
= priv
;
925 if (event
== JTAG_TRST_ASSERTED
)
927 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
934 void jtag_sleep(u32 us
)
936 alive_sleep(us
/1000);
939 /// maximum number of JTAG devices expected in the chain
940 #define JTAG_MAX_CHAIN_SIZE 20
942 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
943 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
944 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
946 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
948 scan_field_t field
= {
950 .num_bits
= num_idcode
* 32,
951 .out_value
= idcode_buffer
,
952 .in_value
= idcode_buffer
,
955 // initialize to the end of chain ID value
956 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
957 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
959 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
960 return jtag_execute_queue();
963 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
968 for (unsigned i
= 0; i
< count
* 4; i
++)
970 zero_check
|= idcodes
[i
];
971 one_check
&= idcodes
[i
];
974 /* if there wasn't a single non-zero bit or if all bits were one,
975 * the scan is not valid */
976 if (zero_check
== 0x00 || one_check
== 0xff)
978 LOG_ERROR("JTAG communication failure: check connection, "
979 "JTAG interface, target power etc.");
985 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
986 const char *name
, u32 idcode
)
988 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
989 "JTAG tap: %s %16.16s: 0x%08x "
990 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
992 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
995 static bool jtag_idcode_is_final(u32 idcode
)
997 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
1001 * This helper checks that remaining bits in the examined chain data are
1002 * all as expected, but a single JTAG device requires only 64 bits to be
1003 * read back correctly. This can help identify and diagnose problems
1004 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1006 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
1008 bool triggered
= false;
1009 for ( ; count
< max
- 31; count
+= 32)
1011 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
1012 // do not trigger the warning if the data looks good
1013 if (!triggered
&& jtag_idcode_is_final(idcode
))
1015 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1021 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s
*tap
)
1023 if (0 == tap
->expected_ids_cnt
)
1025 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1027 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1028 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1033 /* Loop over the expected identification codes and test for a match */
1035 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1037 if (tap
->idcode
== tap
->expected_ids
[ii
])
1041 /* If none of the expected ids matched, log an error */
1042 if (ii
!= tap
->expected_ids_cnt
)
1044 LOG_INFO("JTAG Tap/device matched");
1047 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1048 tap
->dotted_name
, tap
->idcode
);
1049 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++)
1052 snprintf(msg
, sizeof(msg
), "expected %hhu of %hhu",
1053 ii
+ 1, tap
->expected_ids_cnt
);
1054 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1055 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1060 /* Try to examine chain layout according to IEEE 1149.1 §12
1062 static int jtag_examine_chain(void)
1064 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1065 unsigned device_count
= 0;
1067 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1069 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1070 return ERROR_JTAG_INIT_FAILED
;
1072 /* point at the 1st tap */
1073 jtag_tap_t
*tap
= jtag_tap_next_enabled(NULL
);
1076 LOG_ERROR("JTAG: No taps enabled?");
1077 return ERROR_JTAG_INIT_FAILED
;
1080 for (unsigned bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1082 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1083 if ((idcode
& 1) == 0)
1085 /* LSB must not be 0, this indicates a device in bypass */
1086 LOG_WARNING("Tap/Device does not have IDCODE");
1094 * End of chain (invalid manufacturer ID) some devices, such
1095 * as AVR will output all 1's instead of TDI input value at
1098 if (jtag_idcode_is_final(idcode
))
1100 jtag_examine_chain_end(idcode_buffer
,
1101 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1105 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1106 tap
? tap
->dotted_name
: "(not-named)",
1115 tap
->idcode
= idcode
;
1117 // ensure the TAP ID does matches what was expected
1118 if (!jtag_examine_chain_match_tap(tap
))
1119 return ERROR_JTAG_INIT_FAILED
;
1121 tap
= jtag_tap_next_enabled(tap
);
1124 /* see if number of discovered devices matches configuration */
1125 if (device_count
!= jtag_tap_count_enabled())
1127 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1128 "does not match (enabled) configuration (%i), total taps: %d",
1129 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1130 LOG_ERROR("check the config file and ensure proper JTAG communication"
1131 " (connections, speed, ...)");
1132 return ERROR_JTAG_INIT_FAILED
;
1138 static int jtag_validate_chain(void)
1141 int total_ir_length
= 0;
1147 total_ir_length
= 0;
1149 tap
= jtag_tap_next_enabled(tap
);
1153 total_ir_length
+= tap
->ir_length
;
1156 total_ir_length
+= 2;
1157 ir_test
= malloc(CEIL(total_ir_length
, 8));
1158 buf_set_ones(ir_test
, total_ir_length
);
1161 field
.num_bits
= total_ir_length
;
1162 field
.out_value
= ir_test
;
1163 field
.in_value
= ir_test
;
1166 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1167 jtag_execute_queue();
1173 tap
= jtag_tap_next_enabled(tap
);
1178 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1181 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1182 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
);
1185 return ERROR_JTAG_INIT_FAILED
;
1187 chain_pos
+= tap
->ir_length
;
1190 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1193 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1194 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
);
1197 return ERROR_JTAG_INIT_FAILED
;
1205 enum jtag_tap_cfg_param
{
1209 static Jim_Nvp nvp_config_opts
[] = {
1210 { .name
= "-event", .value
= JCFG_EVENT
},
1212 { .name
= NULL
, .value
= -1 }
1215 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1221 /* parse config or cget options */
1222 while (goi
->argc
> 0) {
1223 Jim_SetEmptyResult (goi
->interp
);
1225 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1227 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1233 if (goi
->argc
== 0) {
1234 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1238 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1240 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1244 if (goi
->isconfigure
) {
1245 if (goi
->argc
!= 1) {
1246 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1250 if (goi
->argc
!= 0) {
1251 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1257 jtag_tap_event_action_t
*jteap
;
1259 jteap
= tap
->event_action
;
1260 /* replace existing? */
1262 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1265 jteap
= jteap
->next
;
1268 if (goi
->isconfigure
) {
1269 if (jteap
== NULL
) {
1271 jteap
= calloc(1, sizeof (*jteap
));
1273 jteap
->event
= n
->value
;
1274 Jim_GetOpt_Obj( goi
, &o
);
1276 Jim_DecrRefCount(interp
, jteap
->body
);
1278 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1279 Jim_IncrRefCount(jteap
->body
);
1281 /* add to head of event list */
1282 jteap
->next
= tap
->event_action
;
1283 tap
->event_action
= jteap
;
1284 Jim_SetEmptyResult(goi
->interp
);
1287 if (jteap
== NULL
) {
1288 Jim_SetEmptyResult(goi
->interp
);
1290 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1297 } /* while (goi->argc) */
1303 static void jtag_tap_init(jtag_tap_t
*tap
)
1305 assert(0 != tap
->ir_length
);
1307 tap
->expected
= malloc(tap
->ir_length
);
1308 tap
->expected_mask
= malloc(tap
->ir_length
);
1309 tap
->cur_instr
= malloc(tap
->ir_length
);
1311 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1312 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1313 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1315 // place TAP in bypass mode
1317 // register the reset callback for the TAP
1318 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1320 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1321 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1322 tap
->abs_chain_position
, tap
->ir_length
,
1323 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1327 static void jtag_tap_free(jtag_tap_t
*tap
)
1329 /// @todo is anything missing? no memory leaks please
1330 free((void *)tap
->expected_ids
);
1331 free((void *)tap
->chip
);
1332 free((void *)tap
->tapname
);
1333 free((void *)tap
->dotted_name
);
1337 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1346 const Jim_Nvp opts
[] = {
1347 #define NTAP_OPT_IRLEN 0
1348 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1349 #define NTAP_OPT_IRMASK 1
1350 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1351 #define NTAP_OPT_IRCAPTURE 2
1352 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1353 #define NTAP_OPT_ENABLED 3
1354 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1355 #define NTAP_OPT_DISABLED 4
1356 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1357 #define NTAP_OPT_EXPECTED_ID 5
1358 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1359 { .name
= NULL
, .value
= -1 },
1362 pTap
= malloc( sizeof(jtag_tap_t
) );
1363 memset( pTap
, 0, sizeof(*pTap
) );
1365 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1369 * we expect CHIP + TAP + OPTIONS
1371 if( goi
->argc
< 3 ){
1372 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1375 Jim_GetOpt_String( goi
, &cp
, NULL
);
1376 pTap
->chip
= strdup(cp
);
1378 Jim_GetOpt_String( goi
, &cp
, NULL
);
1379 pTap
->tapname
= strdup(cp
);
1381 /* name + dot + name + null */
1382 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1384 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1385 pTap
->dotted_name
= cp
;
1387 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1388 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1390 /* default is enabled */
1393 /* deal with options */
1394 #define NTREQ_IRLEN 1
1395 #define NTREQ_IRCAPTURE 2
1396 #define NTREQ_IRMASK 4
1398 /* clear them as we find them */
1399 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1402 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1404 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1407 LOG_DEBUG("Processing option: %s", n
->name
);
1409 case NTAP_OPT_ENABLED
:
1412 case NTAP_OPT_DISABLED
:
1415 case NTAP_OPT_EXPECTED_ID
:
1417 u32
*new_expected_ids
;
1419 e
= Jim_GetOpt_Wide( goi
, &w
);
1421 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1425 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1426 if (new_expected_ids
== NULL
) {
1427 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1431 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1433 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1435 free(pTap
->expected_ids
);
1436 pTap
->expected_ids
= new_expected_ids
;
1437 pTap
->expected_ids_cnt
++;
1440 case NTAP_OPT_IRLEN
:
1441 case NTAP_OPT_IRMASK
:
1442 case NTAP_OPT_IRCAPTURE
:
1443 e
= Jim_GetOpt_Wide( goi
, &w
);
1445 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1448 if( (w
< 0) || (w
> 0xffff) ){
1450 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1451 n
->name
, (int)(w
), (int)(w
));
1455 case NTAP_OPT_IRLEN
:
1456 pTap
->ir_length
= w
;
1457 reqbits
&= (~(NTREQ_IRLEN
));
1459 case NTAP_OPT_IRMASK
:
1460 pTap
->ir_capture_mask
= w
;
1461 reqbits
&= (~(NTREQ_IRMASK
));
1463 case NTAP_OPT_IRCAPTURE
:
1464 pTap
->ir_capture_value
= w
;
1465 reqbits
&= (~(NTREQ_IRCAPTURE
));
1468 } /* switch(n->value) */
1469 } /* while( goi->argc ) */
1471 /* Did all the required option bits get cleared? */
1474 jtag_tap_init(pTap
);
1478 Jim_SetResult_sprintf(goi
->interp
,
1479 "newtap: %s missing required parameters",
1481 jtag_tap_free(pTap
);
1485 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1491 struct command_context_s
*context
;
1495 JTAG_CMD_INIT_RESET
,
1498 JTAG_CMD_TAPDISABLE
,
1499 JTAG_CMD_TAPISENABLED
,
1504 const Jim_Nvp jtag_cmds
[] = {
1505 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1506 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1507 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1508 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1509 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1510 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1511 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1512 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1514 { .name
= NULL
, .value
= -1 },
1517 context
= Jim_GetAssocData(interp
, "context");
1518 /* go past the command */
1519 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1521 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1523 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1526 Jim_SetEmptyResult( goi
.interp
);
1528 case JTAG_CMD_INTERFACE
:
1529 /* return the name of the interface */
1530 /* TCL code might need to know the exact type... */
1531 /* FUTURE: we allow this as a means to "set" the interface. */
1532 if( goi
.argc
!= 0 ){
1533 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1536 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1538 case JTAG_CMD_INIT_RESET
:
1539 if( goi
.argc
!= 0 ){
1540 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1543 e
= jtag_init_reset(context
);
1544 if( e
!= ERROR_OK
){
1545 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1549 case JTAG_CMD_NEWTAP
:
1550 return jim_newtap_cmd( &goi
);
1552 case JTAG_CMD_TAPISENABLED
:
1553 case JTAG_CMD_TAPENABLE
:
1554 case JTAG_CMD_TAPDISABLE
:
1555 if( goi
.argc
!= 1 ){
1556 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1562 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1567 case JTAG_CMD_TAPISENABLED
:
1570 case JTAG_CMD_TAPENABLE
:
1571 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1575 case JTAG_CMD_TAPDISABLE
:
1576 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1581 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1588 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1595 Jim_GetOpt_Obj(&goi
, &o
);
1596 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1601 goi
.isconfigure
= 0;
1602 return jtag_tap_configure_cmd( &goi
, t
);
1606 case JTAG_CMD_CONFIGURE
:
1608 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1615 Jim_GetOpt_Obj(&goi
, &o
);
1616 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1621 goi
.isconfigure
= 1;
1622 return jtag_tap_configure_cmd( &goi
, t
);
1629 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1631 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1633 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1634 COMMAND_CONFIG
, "try to configure interface");
1635 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1636 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1637 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1638 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1639 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1640 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1641 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1642 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1644 "[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]");
1645 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1646 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1647 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1648 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1650 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1651 COMMAND_EXEC
, "print current scan chain configuration");
1653 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1654 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1655 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1656 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1657 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1658 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1659 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1660 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1662 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1663 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1664 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1665 COMMAND_ANY
, "verify value capture <enable|disable>");
1666 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1667 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1671 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1676 if (!jtag_interface
)
1678 /* nothing was previously specified by "interface" command */
1679 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1680 return ERROR_JTAG_INVALID_INTERFACE
;
1684 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1688 if (jtag_interface
->init() != ERROR_OK
)
1689 return ERROR_JTAG_INIT_FAILED
;
1691 jtag
= jtag_interface
;
1695 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1700 LOG_DEBUG("Init JTAG chain");
1702 tap
= jtag_tap_next_enabled(NULL
);
1704 LOG_ERROR("There are no enabled taps?");
1705 return ERROR_JTAG_INIT_FAILED
;
1709 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1712 /* examine chain first, as this could discover the real chain layout */
1713 if (jtag_examine_chain() != ERROR_OK
)
1715 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1718 if (jtag_validate_chain() != ERROR_OK
)
1720 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1726 int jtag_interface_quit(void)
1728 if (!jtag
|| !jtag
->quit
)
1731 // close the JTAG interface
1732 int result
= jtag
->quit();
1733 if (ERROR_OK
!= result
)
1734 LOG_ERROR("failed: %d", result
);
1740 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1744 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1747 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1749 /* Reset can happen after a power cycle.
1751 * Ideally we would only assert TRST or run RESET before the target reset.
1753 * However w/srst_pulls_trst, trst is asserted together with the target
1754 * reset whether we want it or not.
1756 * NB! Some targets have JTAG circuitry disabled until a
1757 * trst & srst has been asserted.
1759 * NB! here we assume nsrst/ntrst delay are sufficient!
1761 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1764 jtag_add_reset(1, 0); /* RESET or TRST */
1765 if (jtag_reset_config
& RESET_HAS_SRST
)
1767 jtag_add_reset(1, 1);
1768 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1769 jtag_add_reset(0, 1);
1771 jtag_add_reset(0, 0);
1772 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1775 /* Check that we can communication on the JTAG chain + eventually we want to
1776 * be able to perform enumeration only after OpenOCD has started
1777 * telnet and GDB server
1779 * That would allow users to more easily perform any magic they need to before
1782 return jtag_init_inner(cmd_ctx
);
1785 int jtag_init(struct command_context_s
*cmd_ctx
)
1788 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1790 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1794 return jtag_init_reset(cmd_ctx
);
1797 void jtag_set_speed_khz(unsigned khz
)
1801 unsigned jtag_get_speed_khz(void)
1806 static int default_khz(int khz
, int *jtag_speed
)
1808 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1812 static int default_speed_div(int speed
, int *khz
)
1814 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1818 static int default_power_dropout(int *dropout
)
1820 *dropout
=0; /* by default we can't detect power dropout */
1824 static int default_srst_asserted(int *srst_asserted
)
1826 *srst_asserted
=0; /* by default we can't detect srst asserted */
1830 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1835 /* check whether the interface is already configured */
1838 LOG_WARNING("Interface already configured, ignoring");
1842 /* interface name is a mandatory argument */
1843 if (argc
< 1 || args
[0][0] == '\0')
1845 return ERROR_COMMAND_SYNTAX_ERROR
;
1848 for (i
=0; jtag_interfaces
[i
]; i
++)
1850 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1852 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1857 jtag_interface
= jtag_interfaces
[i
];
1859 if (jtag_interface
->khz
== NULL
)
1861 jtag_interface
->khz
= default_khz
;
1863 if (jtag_interface
->speed_div
== NULL
)
1865 jtag_interface
->speed_div
= default_speed_div
;
1867 if (jtag_interface
->power_dropout
== NULL
)
1869 jtag_interface
->power_dropout
= default_power_dropout
;
1871 if (jtag_interface
->srst_asserted
== NULL
)
1873 jtag_interface
->srst_asserted
= default_srst_asserted
;
1880 /* no valid interface was found (i.e. the configuration option,
1881 * didn't match one of the compiled-in interfaces
1883 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1884 LOG_ERROR("compiled-in jtag interfaces:");
1885 for (i
= 0; jtag_interfaces
[i
]; i
++)
1887 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1890 return ERROR_JTAG_INVALID_INTERFACE
;
1893 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1897 Jim_Obj
*newargs
[ 10 ];
1900 * argv[-1] = command
1901 * argv[ 0] = ir length
1902 * argv[ 1] = ir capture
1903 * argv[ 2] = ir mask
1904 * argv[ 3] = not actually used by anything but in the docs
1908 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1911 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1912 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1916 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1917 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1918 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1919 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1921 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1922 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1923 sprintf( buf
, "chip%d", jtag_tap_count() );
1924 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1925 sprintf( buf
, "tap%d", jtag_tap_count() );
1926 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1927 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1928 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1929 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1930 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1931 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1932 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1934 command_print( cmd_ctx
, "NEW COMMAND:");
1935 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1936 Jim_GetString( newargs
[0], NULL
),
1937 Jim_GetString( newargs
[1], NULL
),
1938 Jim_GetString( newargs
[2], NULL
),
1939 Jim_GetString( newargs
[3], NULL
),
1940 Jim_GetString( newargs
[4], NULL
),
1941 Jim_GetString( newargs
[5], NULL
),
1942 Jim_GetString( newargs
[6], NULL
),
1943 Jim_GetString( newargs
[7], NULL
),
1944 Jim_GetString( newargs
[8], NULL
),
1945 Jim_GetString( newargs
[9], NULL
) );
1947 e
= jim_jtag_command( interp
, 10, newargs
);
1949 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1954 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1958 tap
= jtag_all_taps();
1959 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1960 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1963 u32 expected
, expected_mask
, cur_instr
, ii
;
1964 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1965 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1966 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1968 command_print(cmd_ctx
,
1969 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1970 tap
->abs_chain_position
,
1972 tap
->enabled
? 'Y' : 'n',
1974 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1980 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1981 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1982 tap
->expected_ids
[ii
]);
1985 tap
= tap
->next_tap
;
1991 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1997 return ERROR_COMMAND_SYNTAX_ERROR
;
1999 /* Original versions cared about the order of these tokens:
2000 * reset_config signals [combination [trst_type [srst_type]]]
2001 * They also clobbered the previous configuration even on error.
2003 * Here we don't care about the order, and only change values
2004 * which have been explicitly specified.
2006 for (; argc
; argc
--, args
++) {
2011 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2012 if (strcmp(*args
, "none") == 0)
2014 else if (strcmp(*args
, "trst_only") == 0)
2015 tmp
= RESET_HAS_TRST
;
2016 else if (strcmp(*args
, "srst_only") == 0)
2017 tmp
= RESET_HAS_SRST
;
2018 else if (strcmp(*args
, "trst_and_srst") == 0)
2019 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2023 LOG_ERROR("extra reset_config %s spec (%s)",
2025 return ERROR_INVALID_ARGUMENTS
;
2030 /* combination (options for broken wiring) */
2031 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2032 if (strcmp(*args
, "separate") == 0)
2033 /* separate reset lines - default */;
2034 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2035 tmp
|= RESET_SRST_PULLS_TRST
;
2036 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2037 tmp
|= RESET_TRST_PULLS_SRST
;
2038 else if (strcmp(*args
, "combined") == 0)
2039 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2043 LOG_ERROR("extra reset_config %s spec (%s)",
2044 "combination", *args
);
2045 return ERROR_INVALID_ARGUMENTS
;
2050 /* trst_type (NOP without HAS_TRST) */
2051 m
= RESET_TRST_OPEN_DRAIN
;
2052 if (strcmp(*args
, "trst_open_drain") == 0)
2053 tmp
|= RESET_TRST_OPEN_DRAIN
;
2054 else if (strcmp(*args
, "trst_push_pull") == 0)
2055 /* push/pull from adapter - default */;
2059 LOG_ERROR("extra reset_config %s spec (%s)",
2060 "trst_type", *args
);
2061 return ERROR_INVALID_ARGUMENTS
;
2066 /* srst_type (NOP without HAS_SRST) */
2067 m
|= RESET_SRST_PUSH_PULL
;
2068 if (strcmp(*args
, "srst_push_pull") == 0)
2069 tmp
|= RESET_SRST_PUSH_PULL
;
2070 else if (strcmp(*args
, "srst_open_drain") == 0)
2071 /* open drain from adapter - default */;
2075 LOG_ERROR("extra reset_config %s spec (%s)",
2076 "srst_type", *args
);
2077 return ERROR_INVALID_ARGUMENTS
;
2082 /* caller provided nonsense; fail */
2083 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2084 return ERROR_INVALID_ARGUMENTS
;
2087 /* Remember the bits which were specified (mask)
2088 * and their new values (new_cfg).
2094 /* clear previous values of those bits, save new values */
2095 jtag_reset_config
&= ~mask
;
2096 jtag_reset_config
|= new_cfg
;
2101 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
2102 char *cmd
, char **args
, int argc
)
2105 return ERROR_COMMAND_SYNTAX_ERROR
;
2107 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2108 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2112 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
2113 char *cmd
, char **args
, int argc
)
2116 return ERROR_COMMAND_SYNTAX_ERROR
;
2118 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2119 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2123 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2125 int retval
= ERROR_OK
;
2128 return ERROR_COMMAND_SYNTAX_ERROR
;
2131 LOG_DEBUG("handle jtag speed");
2134 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2136 /* this command can be called during CONFIG,
2137 * in which case jtag isn't initialized */
2139 retval
= jtag
->speed(cur_speed
);
2141 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2146 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2149 return ERROR_COMMAND_SYNTAX_ERROR
;
2151 int retval
= ERROR_OK
;
2155 LOG_DEBUG("handle jtag khz");
2157 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2160 LOG_DEBUG("have interface set up");
2162 retval
= jtag
->khz(jtag_get_speed_khz(), &speed_div1
);
2163 if (ERROR_OK
!= retval
)
2165 jtag_set_speed_khz(0);
2168 cur_speed
= jtag_speed
= speed_div1
;
2170 retval
= jtag
->speed(cur_speed
);
2176 cur_speed
= jtag_get_speed_khz();
2179 retval
= jtag
->speed_div(jtag_speed
, &cur_speed
);
2180 if (ERROR_OK
!= retval
)
2185 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2187 command_print(cmd_ctx
, "RCLK - adaptive");
2192 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
2193 char *cmd
, char **args
, int argc
)
2196 return ERROR_COMMAND_SYNTAX_ERROR
;
2199 if (args
[0][0] == '1')
2201 else if (args
[0][0] == '0')
2204 return ERROR_COMMAND_SYNTAX_ERROR
;
2207 if (args
[1][0] == '1')
2209 else if (args
[1][0] == '0')
2212 return ERROR_COMMAND_SYNTAX_ERROR
;
2214 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2215 return ERROR_JTAG_INIT_FAILED
;
2217 jtag_add_reset(trst
, srst
);
2218 jtag_execute_queue();
2223 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
2224 char *cmd
, char **args
, int argc
)
2227 return ERROR_COMMAND_SYNTAX_ERROR
;
2229 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2230 jtag_execute_queue();
2236 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2237 * should be stable ... and *NOT* a shift state, otherwise free-running
2238 * jtag clocks could change the values latched by the update state.
2240 static bool scan_is_safe(tap_state_t state
)
2255 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2258 scan_field_t
*fields
;
2260 tap_state_t endstate
;
2262 if ((argc
< 2) || (argc
% 2))
2264 return ERROR_COMMAND_SYNTAX_ERROR
;
2267 /* optional "-endstate" "statename" at the end of the arguments,
2268 * so that e.g. IRPAUSE can let us load the data register before
2269 * entering RUN/IDLE to execute the instruction we load here.
2271 endstate
= TAP_IDLE
;
2274 /* have at least one pair of numbers. */
2275 /* is last pair the magic text? */
2276 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2279 cpA
= args
[ argc
-1 ];
2280 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2281 cpS
= tap_state_name( endstate
);
2282 if( 0 == strcmp( cpA
, cpS
) ){
2286 if( endstate
>= TAP_NUM_STATES
){
2287 return ERROR_COMMAND_SYNTAX_ERROR
;
2289 if (!scan_is_safe(endstate
))
2290 LOG_WARNING("irscan with unsafe "
2291 "endstate \"%s\"", cpA
);
2292 /* found - remove the last 2 args */
2298 int num_fields
= argc
/ 2;
2300 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2302 for (i
= 0; i
< num_fields
; i
++)
2304 tap
= jtag_tap_by_string( args
[i
*2] );
2307 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2310 int field_size
= tap
->ir_length
;
2311 fields
[i
].tap
= tap
;
2312 fields
[i
].num_bits
= field_size
;
2313 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2314 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2315 fields
[i
].in_value
= NULL
;
2318 /* did we have an endstate? */
2319 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2321 int retval
=jtag_execute_queue();
2323 for (i
= 0; i
< num_fields
; i
++)
2324 free(fields
[i
].out_value
);
2331 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2334 scan_field_t
*fields
;
2336 int field_count
= 0;
2339 tap_state_t endstate
;
2342 * args[2] = num_bits
2343 * args[3] = hex string
2344 * ... repeat num bits and hex string ...
2347 * args[N-2] = "-endstate"
2348 * args[N-1] = statename
2350 if ((argc
< 4) || ((argc
% 2)!=0))
2352 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2356 endstate
= TAP_IDLE
;
2358 /* validate arguments as numbers */
2360 for (i
= 2; i
< argc
; i
+=2)
2365 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2366 /* If valid - try next arg */
2371 /* Not valid.. are we at the end? */
2372 if ( ((i
+2) != argc
) ){
2373 /* nope, then error */
2377 /* it could be: "-endstate FOO"
2378 * e.g. DRPAUSE so we can issue more instructions
2379 * before entering RUN/IDLE and executing them.
2382 /* get arg as a string. */
2383 cp
= Jim_GetString( args
[i
], NULL
);
2384 /* is it the magic? */
2385 if( 0 == strcmp( "-endstate", cp
) ){
2386 /* is the statename valid? */
2387 cp
= Jim_GetString( args
[i
+1], NULL
);
2389 /* see if it is a valid state name */
2390 endstate
= tap_state_by_name(cp
);
2392 /* update the error message */
2393 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2395 if (!scan_is_safe(endstate
))
2396 LOG_WARNING("drscan with unsafe "
2397 "endstate \"%s\"", cp
);
2399 /* valid - so clear the error */
2401 /* and remove the last 2 args */
2406 /* Still an error? */
2408 return e
; /* too bad */
2410 } /* validate args */
2412 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2417 num_fields
=(argc
-2)/2;
2418 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2419 for (i
= 2; i
< argc
; i
+=2)
2425 Jim_GetLong(interp
, args
[i
], &bits
);
2426 str
= Jim_GetString(args
[i
+1], &len
);
2428 fields
[field_count
].tap
= tap
;
2429 fields
[field_count
].num_bits
= bits
;
2430 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2431 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2432 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2436 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2438 retval
= jtag_execute_queue();
2439 if (retval
!= ERROR_OK
)
2441 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2446 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2447 for (i
= 2; i
< argc
; i
+=2)
2452 Jim_GetLong(interp
, args
[i
], &bits
);
2453 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2454 free(fields
[field_count
].out_value
);
2456 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2461 Jim_SetResult(interp
, list
);
2469 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2471 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2477 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2481 if (strcmp(args
[0], "enable") == 0)
2483 jtag_verify_capture_ir
= 1;
2485 else if (strcmp(args
[0], "disable") == 0)
2487 jtag_verify_capture_ir
= 0;
2490 return ERROR_COMMAND_SYNTAX_ERROR
;
2492 } else if (argc
!= 0)
2494 return ERROR_COMMAND_SYNTAX_ERROR
;
2497 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2502 void jtag_set_verify(bool enable
)
2504 jtag_verify
= enable
;
2507 bool jtag_will_verify()
2512 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2515 return ERROR_COMMAND_SYNTAX_ERROR
;
2519 if (strcmp(args
[0], "enable") == 0)
2520 jtag_set_verify(true);
2521 else if (strcmp(args
[0], "disable") == 0)
2522 jtag_set_verify(false);
2524 return ERROR_COMMAND_SYNTAX_ERROR
;
2527 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2528 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2534 int jtag_power_dropout(int *dropout
)
2536 return jtag
->power_dropout(dropout
);
2539 int jtag_srst_asserted(int *srst_asserted
)
2541 return jtag
->srst_asserted(srst_asserted
);
2544 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2546 jtag_tap_event_action_t
* jteap
;
2549 jteap
= tap
->event_action
;
2553 if (jteap
->event
== e
) {
2555 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2558 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2559 Jim_GetString(jteap
->body
, NULL
) );
2560 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2561 Jim_PrintErrorMessage(interp
);
2565 jteap
= jteap
->next
;
2569 LOG_DEBUG( "event %d %s - no action",
2571 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2575 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2578 return ERROR_COMMAND_SYNTAX_ERROR
;
2583 if (strcmp(args
[0], "short") == 0)
2584 use_new_table
= true;
2585 else if (strcmp(args
[0], "long") == 0)
2586 use_new_table
= false;
2588 return ERROR_COMMAND_SYNTAX_ERROR
;
2590 tap_use_new_tms_table(use_new_table
);
2593 command_print(cmd_ctx
, "tms sequence is %s",
2594 tap_uses_new_tms_table() ? "short": "long");
2600 * Function jtag_add_statemove
2601 * moves from the current state to the goal \a state. This needs
2602 * to be handled according to the xsvf spec, see the XSTATE command
2605 int jtag_add_statemove(tap_state_t goal_state
)
2607 int retval
= ERROR_OK
;
2609 tap_state_t moves
[8];
2610 tap_state_t cur_state
= cmd_queue_cur_state
;
2615 LOG_DEBUG( "cur_state=%s goal_state=%s",
2616 tap_state_name(cur_state
),
2617 tap_state_name(goal_state
) );
2620 /* From the XSVF spec, pertaining to XSTATE:
2622 For special states known as stable states (Test-Logic-Reset,
2623 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2624 predefined TAP state paths when the starting state is a stable state and
2625 when the XSTATE specifies a new stable state (see the STATE command in
2626 the [Ref 5] for the TAP state paths between stable states). For
2627 non-stable states, XSTATE should specify a state that is only one TAP
2628 state transition distance from the current TAP state to avoid undefined
2629 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2630 transition the TAP through a specific state path.
2633 if (goal_state
==cur_state
)
2634 ; /* nothing to do */
2636 else if( goal_state
==TAP_RESET
)
2641 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2643 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2644 spec, then this code is not fully conformant to the xsvf spec. This
2645 puts a burden on tap_get_tms_path() function from the xsvf spec.
2646 If in doubt, you should confirm that that burden is being met.
2649 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2650 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2652 assert( (unsigned) tms_count
< DIM(moves
) );
2654 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2656 bool bit
= tms_bits
& 1;
2658 cur_state
= tap_state_transition(cur_state
, bit
);
2659 moves
[i
] = cur_state
;
2662 jtag_add_pathmove(tms_count
, moves
);
2665 /* else state must be immediately reachable in one clock cycle, and does not
2666 need to be a stable state.
2668 else if( tap_state_transition(cur_state
, true) == goal_state
2669 || tap_state_transition(cur_state
, false) == goal_state
)
2671 /* move a single state */
2672 moves
[0] = goal_state
;
2673 jtag_add_pathmove( 1, moves
);
2678 retval
= ERROR_FAIL
;
2684 void jtag_set_nsrst_delay(unsigned delay
)
2686 jtag_nsrst_delay
= delay
;
2688 unsigned jtag_get_nsrst_delay(void)
2690 return jtag_nsrst_delay
;
2692 void jtag_set_ntrst_delay(unsigned delay
)
2694 jtag_ntrst_delay
= delay
;
2696 unsigned jtag_get_ntrst_delay(void)
2698 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)