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
;
102 #if BUILD_PARPORT == 1
103 extern jtag_interface_t parport_interface
;
107 extern jtag_interface_t dummy_interface
;
110 #if BUILD_FT2232_FTD2XX == 1
111 extern jtag_interface_t ft2232_interface
;
114 #if BUILD_FT2232_LIBFTDI == 1
115 extern jtag_interface_t ft2232_interface
;
118 #if BUILD_AMTJTAGACCEL == 1
119 extern jtag_interface_t amt_jtagaccel_interface
;
122 #if BUILD_EP93XX == 1
123 extern jtag_interface_t ep93xx_interface
;
126 #if BUILD_AT91RM9200 == 1
127 extern jtag_interface_t at91rm9200_interface
;
130 #if BUILD_GW16012 == 1
131 extern jtag_interface_t gw16012_interface
;
134 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
135 extern jtag_interface_t presto_interface
;
138 #if BUILD_USBPROG == 1
139 extern jtag_interface_t usbprog_interface
;
143 extern jtag_interface_t jlink_interface
;
146 #if BUILD_VSLLINK == 1
147 extern jtag_interface_t vsllink_interface
;
151 extern jtag_interface_t rlink_interface
;
154 #if BUILD_ARMJTAGEW == 1
155 extern jtag_interface_t armjtagew_interface
;
158 jtag_interface_t
*jtag_interfaces
[] = {
159 #if BUILD_ECOSBOARD == 1
162 #if BUILD_PARPORT == 1
168 #if BUILD_FT2232_FTD2XX == 1
171 #if BUILD_FT2232_LIBFTDI == 1
174 #if BUILD_AMTJTAGACCEL == 1
175 &amt_jtagaccel_interface
,
177 #if BUILD_EP93XX == 1
180 #if BUILD_AT91RM9200 == 1
181 &at91rm9200_interface
,
183 #if BUILD_GW16012 == 1
186 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
189 #if BUILD_USBPROG == 1
195 #if BUILD_VSLLINK == 1
201 #if BUILD_ARMJTAGEW == 1
202 &armjtagew_interface
,
207 struct jtag_interface_s
*jtag
= NULL
;
210 static jtag_interface_t
*jtag_interface
= NULL
;
214 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
215 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
216 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
217 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
218 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
219 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
220 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
222 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
224 static int handle_endstate_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
225 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
226 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
227 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
228 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
229 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
231 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
232 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
233 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
235 jtag_tap_t
*jtag_all_taps(void)
237 return __jtag_all_taps
;
240 int jtag_tap_count(void)
242 return jtag_num_taps
;
245 int jtag_tap_count_enabled(void)
261 /// Append a new TAP to the chain of all taps.
262 static void jtag_tap_add(struct jtag_tap_s
*t
)
264 t
->abs_chain_position
= jtag_num_taps
++;
266 jtag_tap_t
**tap
= &__jtag_all_taps
;
268 tap
= &(*tap
)->next_tap
;
272 jtag_tap_t
*jtag_tap_by_string( const char *s
)
280 if( 0 == strcmp( t
->dotted_name
, s
) ){
286 /* backup plan is by number */
288 /* ok - is "s" a number? */
290 n
= strtol( s
, &cp
, 0 );
291 if( (s
!= cp
) && (*cp
== 0) ){
293 t
= jtag_tap_by_abs_position(n
);
299 jtag_tap_t
* jtag_tap_by_jim_obj( Jim_Interp
*interp
, Jim_Obj
*o
)
304 cp
= Jim_GetString( o
, NULL
);
309 t
= jtag_tap_by_string( cp
);
312 Jim_SetResult_sprintf(interp
,"Tap: %s is unknown", cp
);
317 /* returns a pointer to the n-th device in the scan chain */
318 jtag_tap_t
* jtag_tap_by_abs_position( int n
)
326 while( t
&& (n
> 0)) {
333 const char *jtag_tap_name(const jtag_tap_t
*tap
)
335 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
339 int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
)
341 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
343 if (callback
== NULL
)
345 return ERROR_INVALID_ARGUMENTS
;
350 while ((*callbacks_p
)->next
)
351 callbacks_p
= &((*callbacks_p
)->next
);
352 callbacks_p
= &((*callbacks_p
)->next
);
355 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
356 (*callbacks_p
)->callback
= callback
;
357 (*callbacks_p
)->priv
= priv
;
358 (*callbacks_p
)->next
= NULL
;
363 int jtag_unregister_event_callback(int (*callback
)(enum jtag_event event
, void *priv
))
365 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
367 if (callback
== NULL
)
369 return ERROR_INVALID_ARGUMENTS
;
374 jtag_event_callback_t
**next
= &((*callbacks_p
)->next
);
375 if ((*callbacks_p
)->callback
== callback
)
378 *callbacks_p
= *next
;
386 int jtag_call_event_callbacks(enum jtag_event event
)
388 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
390 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
394 callback
->callback(event
, callback
->priv
);
395 callback
= callback
->next
;
401 static void jtag_checks(void)
403 assert(jtag_trst
== 0);
406 static void jtag_prelude(tap_state_t state
)
410 assert(state
!=TAP_INVALID
);
412 cmd_queue_cur_state
= state
;
415 void jtag_alloc_in_value32(scan_field_t
*field
)
417 interface_jtag_alloc_in_value32(field
);
420 void jtag_add_ir_scan_noverify(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
425 retval
=interface_jtag_add_ir_scan(in_num_fields
, in_fields
, state
);
426 if (retval
!=ERROR_OK
)
433 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
435 * If the input field list contains an instruction value for a TAP then that is used
436 * otherwise the TAP is set to bypass.
438 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
441 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
443 if (jtag_verify
&&jtag_verify_capture_ir
)
445 /* 8 x 32 bit id's is enough for all invocations */
447 for (int j
= 0; j
< in_num_fields
; j
++)
449 /* if we are to run a verification of the ir scan, we need to get the input back.
450 * We may have to allocate space if the caller didn't ask for the input back.
452 in_fields
[j
].check_value
=in_fields
[j
].tap
->expected
;
453 in_fields
[j
].check_mask
=in_fields
[j
].tap
->expected_mask
;
455 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
458 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
463 * Duplicate the scan fields passed into the function into an IR SCAN command
465 * This function assumes that the caller handles extra fields for bypassed TAPs
468 void jtag_add_plain_ir_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
474 retval
=interface_jtag_add_plain_ir_scan(in_num_fields
, in_fields
, state
);
475 if (retval
!=ERROR_OK
)
479 void jtag_add_callback(jtag_callback1_t f
, u8
*in
)
481 interface_jtag_add_callback(f
, in
);
484 void jtag_add_callback4(jtag_callback_t f
, u8
*in
,
485 jtag_callback_data_t data1
, jtag_callback_data_t data2
,
486 jtag_callback_data_t data3
)
488 interface_jtag_add_callback4(f
, in
, data1
, data2
, data3
);
491 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
);
493 static int jtag_check_value_mask_callback(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
495 return jtag_check_value_inner(in
, (u8
*)data1
, (u8
*)data2
, (int)data3
);
498 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
),
499 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
501 for (int i
= 0; i
< in_num_fields
; i
++)
503 struct scan_field_s
*field
= &in_fields
[i
];
504 field
->allocated
= 0;
506 if (field
->check_value
|| field
->in_value
)
508 interface_jtag_add_scan_check_alloc(field
);
512 jtag_add_scan(in_num_fields
, in_fields
, state
);
514 for (int i
= 0; i
< in_num_fields
; i
++)
516 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
518 /* this is synchronous for a minidriver */
519 jtag_add_callback4(jtag_check_value_mask_callback
, in_fields
[i
].in_value
,
520 (jtag_callback_data_t
)in_fields
[i
].check_value
,
521 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
522 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
524 if (in_fields
[i
].allocated
)
526 free(in_fields
[i
].in_value
);
528 if (in_fields
[i
].modified
)
530 in_fields
[i
].in_value
= NULL
;
535 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
539 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
542 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
548 * Generate a DR SCAN using the fields passed to the function
550 * For not bypassed TAPs the function checks in_fields and uses fields specified there.
551 * For bypassed TAPs the function generates a dummy 1bit field.
553 * The bypass status of TAPs is set by jtag_add_ir_scan().
556 void jtag_add_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
562 retval
=interface_jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
563 if (retval
!=ERROR_OK
)
570 * Duplicate the scan fields passed into the function into a DR SCAN command
572 * This function assumes that the caller handles extra fields for bypassed TAPs
575 void jtag_add_plain_dr_scan(int in_num_fields
, const scan_field_t
*in_fields
, tap_state_t state
)
581 retval
=interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, state
);
582 if (retval
!=ERROR_OK
)
586 void jtag_add_dr_out(jtag_tap_t
* tap
,
587 int num_fields
, const int* num_bits
, const u32
* value
,
588 tap_state_t end_state
)
590 assert(end_state
!= TAP_INVALID
);
592 cmd_queue_cur_state
= end_state
;
594 interface_jtag_add_dr_out(tap
,
595 num_fields
, num_bits
, value
,
599 void jtag_add_tlr(void)
601 jtag_prelude(TAP_RESET
);
604 retval
=interface_jtag_add_tlr();
605 if (retval
!=ERROR_OK
)
608 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
611 void jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
613 tap_state_t cur_state
= cmd_queue_cur_state
;
617 /* the last state has to be a stable state */
618 if (!tap_is_state_stable(path
[num_states
- 1]))
620 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
624 for (i
=0; i
<num_states
; i
++)
626 if (path
[i
] == TAP_RESET
)
628 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
632 if ( tap_state_transition(cur_state
, true) != path
[i
]
633 && tap_state_transition(cur_state
, false) != path
[i
])
635 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[i
]));
643 retval
= interface_jtag_add_pathmove(num_states
, path
);
644 cmd_queue_cur_state
= path
[num_states
- 1];
645 if (retval
!=ERROR_OK
)
649 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
655 /* executed by sw or hw fifo */
656 retval
=interface_jtag_add_runtest(num_cycles
, state
);
657 if (retval
!=ERROR_OK
)
662 void jtag_add_clocks( int num_cycles
)
666 if( !tap_is_state_stable(cmd_queue_cur_state
) )
668 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
669 tap_state_name(cmd_queue_cur_state
) );
670 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
678 retval
= interface_jtag_add_clocks(num_cycles
);
679 if (retval
!= ERROR_OK
)
684 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
686 int trst_with_tlr
= 0;
689 /* FIX!!! there are *many* different cases here. A better
690 * approach is needed for legal combinations of transitions...
692 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
693 (jtag_reset_config
& RESET_HAS_TRST
)&&
694 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
696 if (((req_tlr_or_trst
&&!jtag_trst
)||
697 (!req_tlr_or_trst
&&jtag_trst
))&&
698 ((req_srst
&&!jtag_srst
)||
699 (!req_srst
&&jtag_srst
)))
701 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
702 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
706 /* Make sure that jtag_reset_config allows the requested reset */
707 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
708 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
710 LOG_ERROR("BUG: requested reset would assert trst");
711 jtag_error
=ERROR_FAIL
;
715 /* if TRST pulls SRST, we reset with TAP T-L-R */
716 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
721 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
723 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
724 jtag_error
=ERROR_FAIL
;
730 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
742 jtag_srst
= req_srst
;
744 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
745 if (retval
!=ERROR_OK
)
750 jtag_execute_queue();
754 LOG_DEBUG("SRST line asserted");
758 LOG_DEBUG("SRST line released");
759 if (jtag_nsrst_delay
)
760 jtag_add_sleep(jtag_nsrst_delay
* 1000);
765 LOG_DEBUG("JTAG reset with RESET instead of TRST");
766 jtag_set_end_state(TAP_RESET
);
773 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
774 * and inform possible listeners about this
776 LOG_DEBUG("TRST line asserted");
777 tap_set_state(TAP_RESET
);
778 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
782 if (jtag_ntrst_delay
)
783 jtag_add_sleep(jtag_ntrst_delay
* 1000);
787 tap_state_t
jtag_set_end_state(tap_state_t state
)
789 if ((state
== TAP_DRSHIFT
)||(state
== TAP_IRSHIFT
))
791 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
794 if (state
!=TAP_INVALID
)
795 cmd_queue_end_state
= state
;
796 return cmd_queue_end_state
;
799 tap_state_t
jtag_get_end_state(void)
801 return cmd_queue_end_state
;
804 void jtag_add_sleep(u32 us
)
806 keep_alive(); /* we might be running on a very slow JTAG clk */
807 int retval
=interface_jtag_add_sleep(us
);
808 if (retval
!=ERROR_OK
)
813 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
815 int retval
= ERROR_OK
;
817 int compare_failed
= 0;
820 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
822 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
825 /* An error handler could have caught the failing check
826 * only report a problem when there wasn't a handler, or if the handler
827 * acknowledged the error
830 LOG_WARNING("TAP %s:",
831 jtag_tap_name(field->tap));
835 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
836 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
840 char *in_check_mask_char
;
841 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
842 LOG_WARNING("value captured during scan didn't pass the requested check:");
843 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
844 captured_char
, in_check_value_char
, in_check_mask_char
);
845 free(in_check_mask_char
);
849 LOG_WARNING("value captured during scan didn't pass the requested check: captured: 0x%s check_value: 0x%s", captured_char
, in_check_value_char
);
853 free(in_check_value_char
);
855 retval
= ERROR_JTAG_QUEUE_FAILED
;
862 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
864 assert(field
->in_value
!= NULL
);
868 /* no checking to do */
872 jtag_execute_queue_noclear();
874 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
875 jtag_set_error(retval
);
880 int default_interface_jtag_execute_queue(void)
884 LOG_ERROR("No JTAG interface configured yet. "
885 "Issue 'init' command in startup scripts "
886 "before communicating with targets.");
890 return jtag
->execute_queue();
893 void jtag_execute_queue_noclear(void)
895 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
896 * E.g. a JTAG over TCP/IP or USB....
898 jtag_flush_queue_count
++;
900 int retval
=interface_jtag_execute_queue();
901 /* we keep the first error */
902 if ((jtag_error
==ERROR_OK
)&&(retval
!=ERROR_OK
))
908 int jtag_get_flush_queue_count(void)
910 return jtag_flush_queue_count
;
913 int jtag_execute_queue(void)
916 jtag_execute_queue_noclear();
922 static int jtag_reset_callback(enum jtag_event event
, void *priv
)
924 jtag_tap_t
*tap
= priv
;
928 if (event
== JTAG_TRST_ASSERTED
)
930 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
937 void jtag_sleep(u32 us
)
939 alive_sleep(us
/1000);
942 /// maximum number of JTAG devices expected in the chain
943 #define JTAG_MAX_CHAIN_SIZE 20
945 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
946 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
947 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
949 static int jtag_examine_chain_execute(u8
*idcode_buffer
, unsigned num_idcode
)
951 scan_field_t field
= {
953 .num_bits
= num_idcode
* 32,
954 .out_value
= idcode_buffer
,
955 .in_value
= idcode_buffer
,
958 // initialize to the end of chain ID value
959 for (unsigned i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
960 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
962 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
963 return jtag_execute_queue();
966 static bool jtag_examine_chain_check(u8
*idcodes
, unsigned count
)
971 for (unsigned i
= 0; i
< count
* 4; i
++)
973 zero_check
|= idcodes
[i
];
974 one_check
&= idcodes
[i
];
977 /* if there wasn't a single non-zero bit or if all bits were one,
978 * the scan is not valid */
979 if (zero_check
== 0x00 || one_check
== 0xff)
981 LOG_ERROR("JTAG communication failure: check connection, "
982 "JTAG interface, target power etc.");
988 static void jtag_examine_chain_display(enum log_levels level
, const char *msg
,
989 const char *name
, u32 idcode
)
991 log_printf_lf(level
, __FILE__
, __LINE__
, __FUNCTION__
,
992 "JTAG tap: %s %16.16s: 0x%08x "
993 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
995 EXTRACT_MFG(idcode
), EXTRACT_PART(idcode
), EXTRACT_VER(idcode
) );
998 static bool jtag_idcode_is_final(u32 idcode
)
1000 return idcode
== 0x000000FF || idcode
== 0xFFFFFFFF;
1004 * This helper checks that remaining bits in the examined chain data are
1005 * all as expected, but a single JTAG device requires only 64 bits to be
1006 * read back correctly. This can help identify and diagnose problems
1007 * with the JTAG chain earlier, gives more helpful/explicit error messages.
1009 static void jtag_examine_chain_end(u8
*idcodes
, unsigned count
, unsigned max
)
1011 bool triggered
= false;
1012 for ( ; count
< max
- 31; count
+= 32)
1014 u32 idcode
= buf_get_u32(idcodes
, count
, 32);
1015 // do not trigger the warning if the data looks good
1016 if (!triggered
&& jtag_idcode_is_final(idcode
))
1018 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
1024 /* Try to examine chain layout according to IEEE 1149.1 §12
1026 static int jtag_examine_chain(void)
1029 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1031 int device_count
= 0;
1033 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1035 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1036 return ERROR_JTAG_INIT_FAILED
;
1038 /* point at the 1st tap */
1039 tap
= jtag_tap_next_enabled(NULL
);
1041 LOG_ERROR("JTAG: No taps enabled?");
1042 return ERROR_JTAG_INIT_FAILED
;
1045 for (bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1047 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1048 if ((idcode
& 1) == 0)
1050 /* LSB must not be 0, this indicates a device in bypass */
1051 LOG_WARNING("Tap/Device does not have IDCODE");
1059 * End of chain (invalid manufacturer ID) some devices, such
1060 * as AVR will output all 1's instead of TDI input value at
1063 if (jtag_idcode_is_final(idcode
))
1065 jtag_examine_chain_end(idcode_buffer
,
1066 bit_count
+ 32, JTAG_MAX_CHAIN_SIZE
* 32);
1070 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1071 tap
? tap
->dotted_name
: "(not-named)",
1080 tap
->idcode
= idcode
;
1082 if (0 == tap
->expected_ids_cnt
)
1084 // @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1086 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1087 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1089 tap
= jtag_tap_next_enabled(tap
);
1092 /* Loop over the expected identification codes and test for a match */
1094 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1095 if (tap
->idcode
== tap
->expected_ids
[ii
]) {
1100 /* If none of the expected ids matched, log an error */
1101 if (ii
!= tap
->expected_ids_cnt
)
1103 LOG_INFO("JTAG Tap/device matched");
1104 tap
= jtag_tap_next_enabled(tap
);
1107 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1108 tap
->dotted_name
, tap
->idcode
);
1109 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1111 snprintf(msg
, 20, "expected %hhu of %hhu",
1112 ii
+ 1, tap
->expected_ids_cnt
);
1113 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1114 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1116 return ERROR_JTAG_INIT_FAILED
;
1119 /* see if number of discovered devices matches configuration */
1120 if (device_count
!= jtag_tap_count_enabled())
1122 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1123 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1124 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1125 return ERROR_JTAG_INIT_FAILED
;
1131 static int jtag_validate_chain(void)
1134 int total_ir_length
= 0;
1140 total_ir_length
= 0;
1142 tap
= jtag_tap_next_enabled(tap
);
1146 total_ir_length
+= tap
->ir_length
;
1149 total_ir_length
+= 2;
1150 ir_test
= malloc(CEIL(total_ir_length
, 8));
1151 buf_set_ones(ir_test
, total_ir_length
);
1154 field
.num_bits
= total_ir_length
;
1155 field
.out_value
= ir_test
;
1156 field
.in_value
= ir_test
;
1159 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1160 jtag_execute_queue();
1166 tap
= jtag_tap_next_enabled(tap
);
1171 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1174 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1175 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
);
1178 return ERROR_JTAG_INIT_FAILED
;
1180 chain_pos
+= tap
->ir_length
;
1183 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1186 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1187 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
);
1190 return ERROR_JTAG_INIT_FAILED
;
1198 enum jtag_tap_cfg_param
{
1202 static Jim_Nvp nvp_config_opts
[] = {
1203 { .name
= "-event", .value
= JCFG_EVENT
},
1205 { .name
= NULL
, .value
= -1 }
1208 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1214 /* parse config or cget options */
1215 while (goi
->argc
> 0) {
1216 Jim_SetEmptyResult (goi
->interp
);
1218 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1220 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1226 if (goi
->argc
== 0) {
1227 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1231 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1233 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1237 if (goi
->isconfigure
) {
1238 if (goi
->argc
!= 1) {
1239 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1243 if (goi
->argc
!= 0) {
1244 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1250 jtag_tap_event_action_t
*jteap
;
1252 jteap
= tap
->event_action
;
1253 /* replace existing? */
1255 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1258 jteap
= jteap
->next
;
1261 if (goi
->isconfigure
) {
1262 if (jteap
== NULL
) {
1264 jteap
= calloc(1, sizeof (*jteap
));
1266 jteap
->event
= n
->value
;
1267 Jim_GetOpt_Obj( goi
, &o
);
1269 Jim_DecrRefCount(interp
, jteap
->body
);
1271 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1272 Jim_IncrRefCount(jteap
->body
);
1274 /* add to head of event list */
1275 jteap
->next
= tap
->event_action
;
1276 tap
->event_action
= jteap
;
1277 Jim_SetEmptyResult(goi
->interp
);
1280 if (jteap
== NULL
) {
1281 Jim_SetEmptyResult(goi
->interp
);
1283 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1290 } /* while (goi->argc) */
1296 static void jtag_tap_init(jtag_tap_t
*tap
)
1298 assert(0 != tap
->ir_length
);
1300 tap
->expected
= malloc(tap
->ir_length
);
1301 tap
->expected_mask
= malloc(tap
->ir_length
);
1302 tap
->cur_instr
= malloc(tap
->ir_length
);
1304 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1305 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1306 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1308 // place TAP in bypass mode
1310 // register the reset callback for the TAP
1311 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1313 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1314 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1315 tap
->abs_chain_position
, tap
->ir_length
,
1316 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1320 static void jtag_tap_free(jtag_tap_t
*tap
)
1322 /// @todo is anything missing? no memory leaks please
1323 free((void *)tap
->expected_ids
);
1324 free((void *)tap
->chip
);
1325 free((void *)tap
->tapname
);
1326 free((void *)tap
->dotted_name
);
1330 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1339 const Jim_Nvp opts
[] = {
1340 #define NTAP_OPT_IRLEN 0
1341 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1342 #define NTAP_OPT_IRMASK 1
1343 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1344 #define NTAP_OPT_IRCAPTURE 2
1345 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1346 #define NTAP_OPT_ENABLED 3
1347 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1348 #define NTAP_OPT_DISABLED 4
1349 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1350 #define NTAP_OPT_EXPECTED_ID 5
1351 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1352 { .name
= NULL
, .value
= -1 },
1355 pTap
= malloc( sizeof(jtag_tap_t
) );
1356 memset( pTap
, 0, sizeof(*pTap
) );
1358 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1362 * we expect CHIP + TAP + OPTIONS
1364 if( goi
->argc
< 3 ){
1365 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1368 Jim_GetOpt_String( goi
, &cp
, NULL
);
1369 pTap
->chip
= strdup(cp
);
1371 Jim_GetOpt_String( goi
, &cp
, NULL
);
1372 pTap
->tapname
= strdup(cp
);
1374 /* name + dot + name + null */
1375 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1377 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1378 pTap
->dotted_name
= cp
;
1380 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1381 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1383 /* default is enabled */
1386 /* deal with options */
1387 #define NTREQ_IRLEN 1
1388 #define NTREQ_IRCAPTURE 2
1389 #define NTREQ_IRMASK 4
1391 /* clear them as we find them */
1392 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1395 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1397 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1400 LOG_DEBUG("Processing option: %s", n
->name
);
1402 case NTAP_OPT_ENABLED
:
1405 case NTAP_OPT_DISABLED
:
1408 case NTAP_OPT_EXPECTED_ID
:
1410 u32
*new_expected_ids
;
1412 e
= Jim_GetOpt_Wide( goi
, &w
);
1414 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1418 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1419 if (new_expected_ids
== NULL
) {
1420 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1424 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1426 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1428 free(pTap
->expected_ids
);
1429 pTap
->expected_ids
= new_expected_ids
;
1430 pTap
->expected_ids_cnt
++;
1433 case NTAP_OPT_IRLEN
:
1434 case NTAP_OPT_IRMASK
:
1435 case NTAP_OPT_IRCAPTURE
:
1436 e
= Jim_GetOpt_Wide( goi
, &w
);
1438 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1441 if( (w
< 0) || (w
> 0xffff) ){
1443 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1444 n
->name
, (int)(w
), (int)(w
));
1448 case NTAP_OPT_IRLEN
:
1449 pTap
->ir_length
= w
;
1450 reqbits
&= (~(NTREQ_IRLEN
));
1452 case NTAP_OPT_IRMASK
:
1453 pTap
->ir_capture_mask
= w
;
1454 reqbits
&= (~(NTREQ_IRMASK
));
1456 case NTAP_OPT_IRCAPTURE
:
1457 pTap
->ir_capture_value
= w
;
1458 reqbits
&= (~(NTREQ_IRCAPTURE
));
1461 } /* switch(n->value) */
1462 } /* while( goi->argc ) */
1464 /* Did all the required option bits get cleared? */
1467 jtag_tap_init(pTap
);
1471 Jim_SetResult_sprintf(goi
->interp
,
1472 "newtap: %s missing required parameters",
1474 jtag_tap_free(pTap
);
1478 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1484 struct command_context_s
*context
;
1488 JTAG_CMD_INIT_RESET
,
1491 JTAG_CMD_TAPDISABLE
,
1492 JTAG_CMD_TAPISENABLED
,
1497 const Jim_Nvp jtag_cmds
[] = {
1498 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1499 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1500 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1501 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1502 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1503 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1504 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1505 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1507 { .name
= NULL
, .value
= -1 },
1510 context
= Jim_GetAssocData(interp
, "context");
1511 /* go past the command */
1512 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1514 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1516 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1519 Jim_SetEmptyResult( goi
.interp
);
1521 case JTAG_CMD_INTERFACE
:
1522 /* return the name of the interface */
1523 /* TCL code might need to know the exact type... */
1524 /* FUTURE: we allow this as a means to "set" the interface. */
1525 if( goi
.argc
!= 0 ){
1526 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1529 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1531 case JTAG_CMD_INIT_RESET
:
1532 if( goi
.argc
!= 0 ){
1533 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1536 e
= jtag_init_reset(context
);
1537 if( e
!= ERROR_OK
){
1538 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1542 case JTAG_CMD_NEWTAP
:
1543 return jim_newtap_cmd( &goi
);
1545 case JTAG_CMD_TAPISENABLED
:
1546 case JTAG_CMD_TAPENABLE
:
1547 case JTAG_CMD_TAPDISABLE
:
1548 if( goi
.argc
!= 1 ){
1549 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1555 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1560 case JTAG_CMD_TAPISENABLED
:
1563 case JTAG_CMD_TAPENABLE
:
1564 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1568 case JTAG_CMD_TAPDISABLE
:
1569 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1574 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1581 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1588 Jim_GetOpt_Obj(&goi
, &o
);
1589 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1594 goi
.isconfigure
= 0;
1595 return jtag_tap_configure_cmd( &goi
, t
);
1599 case JTAG_CMD_CONFIGURE
:
1601 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1608 Jim_GetOpt_Obj(&goi
, &o
);
1609 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1614 goi
.isconfigure
= 1;
1615 return jtag_tap_configure_cmd( &goi
, t
);
1622 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1624 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1626 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1627 COMMAND_CONFIG
, "try to configure interface");
1628 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1629 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1630 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1631 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1632 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1633 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1634 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1635 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1637 "[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]");
1638 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1639 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1640 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1641 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1643 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1644 COMMAND_EXEC
, "print current scan chain configuration");
1646 register_command(cmd_ctx
, NULL
, "endstate", handle_endstate_command
,
1647 COMMAND_EXEC
, "finish JTAG operations in <tap_state>");
1648 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1649 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1650 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1651 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1652 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1653 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1654 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1655 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1657 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1658 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1659 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1660 COMMAND_ANY
, "verify value capture <enable|disable>");
1661 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1662 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1666 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1671 if (!jtag_interface
)
1673 /* nothing was previously specified by "interface" command */
1674 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1675 return ERROR_JTAG_INVALID_INTERFACE
;
1679 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1683 if (jtag_interface
->init() != ERROR_OK
)
1684 return ERROR_JTAG_INIT_FAILED
;
1686 jtag
= jtag_interface
;
1690 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1695 LOG_DEBUG("Init JTAG chain");
1697 tap
= jtag_tap_next_enabled(NULL
);
1699 LOG_ERROR("There are no enabled taps?");
1700 return ERROR_JTAG_INIT_FAILED
;
1704 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1707 /* examine chain first, as this could discover the real chain layout */
1708 if (jtag_examine_chain() != ERROR_OK
)
1710 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1713 if (jtag_validate_chain() != ERROR_OK
)
1715 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1721 int jtag_interface_quit(void)
1723 if (!jtag
|| !jtag
->quit
)
1726 // close the JTAG interface
1727 int result
= jtag
->quit();
1728 if (ERROR_OK
!= result
)
1729 LOG_ERROR("failed: %d", result
);
1735 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1739 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1742 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1744 /* Reset can happen after a power cycle.
1746 * Ideally we would only assert TRST or run RESET before the target reset.
1748 * However w/srst_pulls_trst, trst is asserted together with the target
1749 * reset whether we want it or not.
1751 * NB! Some targets have JTAG circuitry disabled until a
1752 * trst & srst has been asserted.
1754 * NB! here we assume nsrst/ntrst delay are sufficient!
1756 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1759 jtag_add_reset(1, 0); /* RESET or TRST */
1760 if (jtag_reset_config
& RESET_HAS_SRST
)
1762 jtag_add_reset(1, 1);
1763 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1764 jtag_add_reset(0, 1);
1766 jtag_add_reset(0, 0);
1767 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1770 /* Check that we can communication on the JTAG chain + eventually we want to
1771 * be able to perform enumeration only after OpenOCD has started
1772 * telnet and GDB server
1774 * That would allow users to more easily perform any magic they need to before
1777 return jtag_init_inner(cmd_ctx
);
1780 int jtag_init(struct command_context_s
*cmd_ctx
)
1783 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1785 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1789 return jtag_init_reset(cmd_ctx
);
1792 void jtag_set_speed_khz(unsigned khz
)
1796 unsigned jtag_get_speed_khz(void)
1801 static int default_khz(int khz
, int *jtag_speed
)
1803 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1807 static int default_speed_div(int speed
, int *khz
)
1809 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1813 static int default_power_dropout(int *dropout
)
1815 *dropout
=0; /* by default we can't detect power dropout */
1819 static int default_srst_asserted(int *srst_asserted
)
1821 *srst_asserted
=0; /* by default we can't detect srst asserted */
1825 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1830 /* check whether the interface is already configured */
1833 LOG_WARNING("Interface already configured, ignoring");
1837 /* interface name is a mandatory argument */
1838 if (argc
< 1 || args
[0][0] == '\0')
1840 return ERROR_COMMAND_SYNTAX_ERROR
;
1843 for (i
=0; jtag_interfaces
[i
]; i
++)
1845 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1847 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1852 jtag_interface
= jtag_interfaces
[i
];
1854 if (jtag_interface
->khz
== NULL
)
1856 jtag_interface
->khz
= default_khz
;
1858 if (jtag_interface
->speed_div
== NULL
)
1860 jtag_interface
->speed_div
= default_speed_div
;
1862 if (jtag_interface
->power_dropout
== NULL
)
1864 jtag_interface
->power_dropout
= default_power_dropout
;
1866 if (jtag_interface
->srst_asserted
== NULL
)
1868 jtag_interface
->srst_asserted
= default_srst_asserted
;
1875 /* no valid interface was found (i.e. the configuration option,
1876 * didn't match one of the compiled-in interfaces
1878 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1879 LOG_ERROR("compiled-in jtag interfaces:");
1880 for (i
= 0; jtag_interfaces
[i
]; i
++)
1882 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1885 return ERROR_JTAG_INVALID_INTERFACE
;
1888 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1892 Jim_Obj
*newargs
[ 10 ];
1895 * argv[-1] = command
1896 * argv[ 0] = ir length
1897 * argv[ 1] = ir capture
1898 * argv[ 2] = ir mask
1899 * argv[ 3] = not actually used by anything but in the docs
1903 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1906 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1907 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1911 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1912 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1913 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1914 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1916 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1917 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1918 sprintf( buf
, "chip%d", jtag_tap_count() );
1919 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1920 sprintf( buf
, "tap%d", jtag_tap_count() );
1921 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1922 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1923 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1924 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1925 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1926 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1927 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1929 command_print( cmd_ctx
, "NEW COMMAND:");
1930 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1931 Jim_GetString( newargs
[0], NULL
),
1932 Jim_GetString( newargs
[1], NULL
),
1933 Jim_GetString( newargs
[2], NULL
),
1934 Jim_GetString( newargs
[3], NULL
),
1935 Jim_GetString( newargs
[4], NULL
),
1936 Jim_GetString( newargs
[5], NULL
),
1937 Jim_GetString( newargs
[6], NULL
),
1938 Jim_GetString( newargs
[7], NULL
),
1939 Jim_GetString( newargs
[8], NULL
),
1940 Jim_GetString( newargs
[9], NULL
) );
1942 e
= jim_jtag_command( interp
, 10, newargs
);
1944 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1949 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1953 tap
= jtag_all_taps();
1954 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1955 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1958 u32 expected
, expected_mask
, cur_instr
, ii
;
1959 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1960 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1961 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1963 command_print(cmd_ctx
,
1964 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1965 tap
->abs_chain_position
,
1967 tap
->enabled
? 'Y' : 'n',
1969 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1975 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1976 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1977 tap
->expected_ids
[ii
]);
1980 tap
= tap
->next_tap
;
1986 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1992 return ERROR_COMMAND_SYNTAX_ERROR
;
1994 /* Original versions cared about the order of these tokens:
1995 * reset_config signals [combination [trst_type [srst_type]]]
1996 * They also clobbered the previous configuration even on error.
1998 * Here we don't care about the order, and only change values
1999 * which have been explicitly specified.
2001 for (; argc
; argc
--, args
++) {
2006 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2007 if (strcmp(*args
, "none") == 0)
2009 else if (strcmp(*args
, "trst_only") == 0)
2010 tmp
= RESET_HAS_TRST
;
2011 else if (strcmp(*args
, "srst_only") == 0)
2012 tmp
= RESET_HAS_SRST
;
2013 else if (strcmp(*args
, "trst_and_srst") == 0)
2014 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2018 LOG_ERROR("extra reset_config %s spec (%s)",
2020 return ERROR_INVALID_ARGUMENTS
;
2025 /* combination (options for broken wiring) */
2026 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2027 if (strcmp(*args
, "separate") == 0)
2028 /* separate reset lines - default */;
2029 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2030 tmp
|= RESET_SRST_PULLS_TRST
;
2031 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2032 tmp
|= RESET_TRST_PULLS_SRST
;
2033 else if (strcmp(*args
, "combined") == 0)
2034 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2038 LOG_ERROR("extra reset_config %s spec (%s)",
2039 "combination", *args
);
2040 return ERROR_INVALID_ARGUMENTS
;
2045 /* trst_type (NOP without HAS_TRST) */
2046 m
= RESET_TRST_OPEN_DRAIN
;
2047 if (strcmp(*args
, "trst_open_drain") == 0)
2048 tmp
|= RESET_TRST_OPEN_DRAIN
;
2049 else if (strcmp(*args
, "trst_push_pull") == 0)
2050 /* push/pull from adapter - default */;
2054 LOG_ERROR("extra reset_config %s spec (%s)",
2055 "trst_type", *args
);
2056 return ERROR_INVALID_ARGUMENTS
;
2061 /* srst_type (NOP without HAS_SRST) */
2062 m
|= RESET_SRST_PUSH_PULL
;
2063 if (strcmp(*args
, "srst_push_pull") == 0)
2064 tmp
|= RESET_SRST_PUSH_PULL
;
2065 else if (strcmp(*args
, "srst_open_drain") == 0)
2066 /* open drain from adapter - default */;
2070 LOG_ERROR("extra reset_config %s spec (%s)",
2071 "srst_type", *args
);
2072 return ERROR_INVALID_ARGUMENTS
;
2077 /* caller provided nonsense; fail */
2078 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2079 return ERROR_INVALID_ARGUMENTS
;
2082 /* Remember the bits which were specified (mask)
2083 * and their new values (new_cfg).
2089 /* clear previous values of those bits, save new values */
2090 jtag_reset_config
&= ~mask
;
2091 jtag_reset_config
|= new_cfg
;
2096 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2100 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2105 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2111 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2115 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2120 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2127 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2129 int retval
=ERROR_OK
;
2133 LOG_DEBUG("handle jtag speed");
2136 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2138 /* this command can be called during CONFIG,
2139 * in which case jtag isn't initialized */
2142 retval
=jtag
->speed(cur_speed
);
2144 } else if (argc
== 0)
2148 return ERROR_COMMAND_SYNTAX_ERROR
;
2150 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2155 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2157 int retval
=ERROR_OK
;
2158 LOG_DEBUG("handle jtag khz");
2163 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2166 LOG_DEBUG("have interface set up");
2168 if ((retval
=jtag
->khz(jtag_get_speed_khz(), &speed_div1
))!=ERROR_OK
)
2170 jtag_set_speed_khz(0);
2174 cur_speed
= jtag_speed
= speed_div1
;
2176 retval
=jtag
->speed(cur_speed
);
2185 return ERROR_COMMAND_SYNTAX_ERROR
;
2187 cur_speed
= jtag_get_speed_khz();
2191 if ((retval
=jtag
->speed_div(jtag_speed
, &cur_speed
))!=ERROR_OK
)
2196 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2198 command_print(cmd_ctx
, "RCLK - adaptive");
2203 static int handle_endstate_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2206 return ERROR_COMMAND_SYNTAX_ERROR
;
2208 tap_state_t state
= tap_state_by_name(args
[0]);
2211 command_print( cmd_ctx
, "Invalid state name: %s\n", args
[0] );
2212 return ERROR_COMMAND_SYNTAX_ERROR
;
2214 jtag_set_end_state(state
);
2215 jtag_execute_queue();
2217 command_print(cmd_ctx
, "current endstate: %s",
2218 tap_state_name(cmd_queue_end_state
));
2223 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2230 return ERROR_COMMAND_SYNTAX_ERROR
;
2233 if (args
[0][0] == '1')
2235 else if (args
[0][0] == '0')
2239 return ERROR_COMMAND_SYNTAX_ERROR
;
2242 if (args
[1][0] == '1')
2244 else if (args
[1][0] == '0')
2248 return ERROR_COMMAND_SYNTAX_ERROR
;
2251 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2252 return ERROR_JTAG_INIT_FAILED
;
2254 jtag_add_reset(trst
, srst
);
2255 jtag_execute_queue();
2260 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2264 return ERROR_COMMAND_SYNTAX_ERROR
;
2267 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2268 jtag_execute_queue();
2275 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2276 * should be stable ... and *NOT* a shift state, otherwise free-running
2277 * jtag clocks could change the values latched by the update state.
2279 static bool scan_is_safe(tap_state_t state
)
2294 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2297 scan_field_t
*fields
;
2299 tap_state_t endstate
;
2301 if ((argc
< 2) || (argc
% 2))
2303 return ERROR_COMMAND_SYNTAX_ERROR
;
2306 /* optional "-endstate" "statename" at the end of the arguments,
2307 * so that e.g. IRPAUSE can let us load the data register before
2308 * entering RUN/IDLE to execute the instruction we load here.
2310 endstate
= TAP_IDLE
;
2313 /* have at least one pair of numbers. */
2314 /* is last pair the magic text? */
2315 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2318 cpA
= args
[ argc
-1 ];
2319 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2320 cpS
= tap_state_name( endstate
);
2321 if( 0 == strcmp( cpA
, cpS
) ){
2325 if( endstate
>= TAP_NUM_STATES
){
2326 return ERROR_COMMAND_SYNTAX_ERROR
;
2328 if (!scan_is_safe(endstate
))
2329 LOG_WARNING("irscan with unsafe "
2330 "endstate \"%s\"", cpA
);
2331 /* found - remove the last 2 args */
2337 int num_fields
= argc
/ 2;
2339 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2341 for (i
= 0; i
< num_fields
; i
++)
2343 tap
= jtag_tap_by_string( args
[i
*2] );
2346 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2349 int field_size
= tap
->ir_length
;
2350 fields
[i
].tap
= tap
;
2351 fields
[i
].num_bits
= field_size
;
2352 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2353 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2354 fields
[i
].in_value
= NULL
;
2357 /* did we have an endstate? */
2358 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2360 int retval
=jtag_execute_queue();
2362 for (i
= 0; i
< num_fields
; i
++)
2363 free(fields
[i
].out_value
);
2370 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2373 scan_field_t
*fields
;
2375 int field_count
= 0;
2378 tap_state_t endstate
;
2381 * args[2] = num_bits
2382 * args[3] = hex string
2383 * ... repeat num bits and hex string ...
2386 * args[N-2] = "-endstate"
2387 * args[N-1] = statename
2389 if ((argc
< 4) || ((argc
% 2)!=0))
2391 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2395 endstate
= TAP_IDLE
;
2397 /* validate arguments as numbers */
2399 for (i
= 2; i
< argc
; i
+=2)
2404 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2405 /* If valid - try next arg */
2410 /* Not valid.. are we at the end? */
2411 if ( ((i
+2) != argc
) ){
2412 /* nope, then error */
2416 /* it could be: "-endstate FOO"
2417 * e.g. DRPAUSE so we can issue more instructions
2418 * before entering RUN/IDLE and executing them.
2421 /* get arg as a string. */
2422 cp
= Jim_GetString( args
[i
], NULL
);
2423 /* is it the magic? */
2424 if( 0 == strcmp( "-endstate", cp
) ){
2425 /* is the statename valid? */
2426 cp
= Jim_GetString( args
[i
+1], NULL
);
2428 /* see if it is a valid state name */
2429 endstate
= tap_state_by_name(cp
);
2431 /* update the error message */
2432 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2434 if (!scan_is_safe(endstate
))
2435 LOG_WARNING("drscan with unsafe "
2436 "endstate \"%s\"", cp
);
2438 /* valid - so clear the error */
2440 /* and remove the last 2 args */
2445 /* Still an error? */
2447 return e
; /* too bad */
2449 } /* validate args */
2451 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2456 num_fields
=(argc
-2)/2;
2457 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2458 for (i
= 2; i
< argc
; i
+=2)
2464 Jim_GetLong(interp
, args
[i
], &bits
);
2465 str
= Jim_GetString(args
[i
+1], &len
);
2467 fields
[field_count
].tap
= tap
;
2468 fields
[field_count
].num_bits
= bits
;
2469 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2470 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2471 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2475 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2477 retval
= jtag_execute_queue();
2478 if (retval
!= ERROR_OK
)
2480 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2485 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2486 for (i
= 2; i
< argc
; i
+=2)
2491 Jim_GetLong(interp
, args
[i
], &bits
);
2492 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2493 free(fields
[field_count
].out_value
);
2495 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2500 Jim_SetResult(interp
, list
);
2508 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2510 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2516 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2520 if (strcmp(args
[0], "enable") == 0)
2522 jtag_verify_capture_ir
= 1;
2524 else if (strcmp(args
[0], "disable") == 0)
2526 jtag_verify_capture_ir
= 0;
2529 return ERROR_COMMAND_SYNTAX_ERROR
;
2531 } else if (argc
!= 0)
2533 return ERROR_COMMAND_SYNTAX_ERROR
;
2536 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2541 void jtag_set_verify(bool enable
)
2543 jtag_verify
= enable
;
2546 bool jtag_will_verify()
2551 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2554 return ERROR_COMMAND_SYNTAX_ERROR
;
2558 if (strcmp(args
[0], "enable") == 0)
2559 jtag_set_verify(true);
2560 else if (strcmp(args
[0], "disable") == 0)
2561 jtag_set_verify(false);
2563 return ERROR_COMMAND_SYNTAX_ERROR
;
2566 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2567 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2573 int jtag_power_dropout(int *dropout
)
2575 return jtag
->power_dropout(dropout
);
2578 int jtag_srst_asserted(int *srst_asserted
)
2580 return jtag
->srst_asserted(srst_asserted
);
2583 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2585 jtag_tap_event_action_t
* jteap
;
2588 jteap
= tap
->event_action
;
2592 if (jteap
->event
== e
) {
2594 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2597 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2598 Jim_GetString(jteap
->body
, NULL
) );
2599 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2600 Jim_PrintErrorMessage(interp
);
2604 jteap
= jteap
->next
;
2608 LOG_DEBUG( "event %d %s - no action",
2610 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2614 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2617 return ERROR_COMMAND_SYNTAX_ERROR
;
2622 if (strcmp(args
[0], "short") == 0)
2623 use_new_table
= true;
2624 else if (strcmp(args
[0], "long") == 0)
2625 use_new_table
= false;
2627 return ERROR_COMMAND_SYNTAX_ERROR
;
2629 tap_use_new_tms_table(use_new_table
);
2632 command_print(cmd_ctx
, "tms sequence is %s",
2633 tap_uses_new_tms_table() ? "short": "long");
2639 * Function jtag_add_statemove
2640 * moves from the current state to the goal \a state. This needs
2641 * to be handled according to the xsvf spec, see the XSTATE command
2644 int jtag_add_statemove(tap_state_t goal_state
)
2646 int retval
= ERROR_OK
;
2648 tap_state_t moves
[8];
2649 tap_state_t cur_state
= cmd_queue_cur_state
;
2654 LOG_DEBUG( "cur_state=%s goal_state=%s",
2655 tap_state_name(cur_state
),
2656 tap_state_name(goal_state
) );
2659 /* From the XSVF spec, pertaining to XSTATE:
2661 For special states known as stable states (Test-Logic-Reset,
2662 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2663 predefined TAP state paths when the starting state is a stable state and
2664 when the XSTATE specifies a new stable state (see the STATE command in
2665 the [Ref 5] for the TAP state paths between stable states). For
2666 non-stable states, XSTATE should specify a state that is only one TAP
2667 state transition distance from the current TAP state to avoid undefined
2668 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2669 transition the TAP through a specific state path.
2672 if (goal_state
==cur_state
)
2673 ; /* nothing to do */
2675 else if( goal_state
==TAP_RESET
)
2680 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2682 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2683 spec, then this code is not fully conformant to the xsvf spec. This
2684 puts a burden on tap_get_tms_path() function from the xsvf spec.
2685 If in doubt, you should confirm that that burden is being met.
2688 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2689 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2691 assert( (unsigned) tms_count
< DIM(moves
) );
2693 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2695 bool bit
= tms_bits
& 1;
2697 cur_state
= tap_state_transition(cur_state
, bit
);
2698 moves
[i
] = cur_state
;
2701 jtag_add_pathmove(tms_count
, moves
);
2704 /* else state must be immediately reachable in one clock cycle, and does not
2705 need to be a stable state.
2707 else if( tap_state_transition(cur_state
, true) == goal_state
2708 || tap_state_transition(cur_state
, false) == goal_state
)
2710 /* move a single state */
2711 moves
[0] = goal_state
;
2712 jtag_add_pathmove( 1, moves
);
2717 retval
= ERROR_FAIL
;
2723 void jtag_set_nsrst_delay(unsigned delay
)
2725 jtag_nsrst_delay
= delay
;
2727 void jtag_set_ntrst_delay(unsigned delay
)
2729 jtag_ntrst_delay
= 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)