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 /* Try to examine chain layout according to IEEE 1149.1 §12
1000 static int jtag_examine_chain(void)
1003 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1005 int device_count
= 0;
1007 jtag_examine_chain_execute(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
);
1009 if (!jtag_examine_chain_check(idcode_buffer
, JTAG_MAX_CHAIN_SIZE
))
1010 return ERROR_JTAG_INIT_FAILED
;
1012 /* point at the 1st tap */
1013 tap
= jtag_tap_next_enabled(NULL
);
1015 LOG_ERROR("JTAG: No taps enabled?");
1016 return ERROR_JTAG_INIT_FAILED
;
1019 for (bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1021 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1022 if ((idcode
& 1) == 0)
1024 /* LSB must not be 0, this indicates a device in bypass */
1025 LOG_WARNING("Tap/Device does not have IDCODE");
1032 /* some devices, such as AVR will output all 1's instead of TDI
1033 input value at end of chain. */
1034 if ((idcode
== 0x000000FF)||(idcode
== 0xFFFFFFFF))
1037 /* End of chain (invalid manufacturer ID)
1039 * The JTAG examine is the very first thing that happens
1041 * A single JTAG device requires only 64 bits to be read back correctly.
1043 * The code below adds a check that the rest of the data scanned (640 bits)
1044 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1046 * earlier and gives more helpful/explicit error messages.
1048 for (bit_count
+= 32; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;bit_count
+= 32)
1050 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1051 if (unexpected
||((idcode
!= 0x000000FF)&&(idcode
!= 0xFFFFFFFF)))
1053 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count
, idcode
);
1061 jtag_examine_chain_display(LOG_LVL_INFO
, "tap/device found",
1062 tap
? tap
->dotted_name
: "(not-named)",
1071 tap
->idcode
= idcode
;
1073 if (0 == tap
->expected_ids_cnt
)
1075 // @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
1077 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap
->idcode
)
1078 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
1080 tap
= jtag_tap_next_enabled(tap
);
1083 /* Loop over the expected identification codes and test for a match */
1085 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1086 if (tap
->idcode
== tap
->expected_ids
[ii
]) {
1091 /* If none of the expected ids matched, log an error */
1092 if (ii
!= tap
->expected_ids_cnt
)
1094 LOG_INFO("JTAG Tap/device matched");
1095 tap
= jtag_tap_next_enabled(tap
);
1098 jtag_examine_chain_display(LOG_LVL_ERROR
, "got",
1099 tap
->dotted_name
, tap
->idcode
);
1100 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1102 snprintf(msg
, 20, "expected %hhu of %hhu",
1103 ii
+ 1, tap
->expected_ids_cnt
);
1104 jtag_examine_chain_display(LOG_LVL_ERROR
, msg
,
1105 tap
->dotted_name
, tap
->expected_ids
[ii
]);
1107 return ERROR_JTAG_INIT_FAILED
;
1110 /* see if number of discovered devices matches configuration */
1111 if (device_count
!= jtag_tap_count_enabled())
1113 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1114 device_count
, jtag_tap_count_enabled(), jtag_tap_count());
1115 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1116 return ERROR_JTAG_INIT_FAILED
;
1122 static int jtag_validate_chain(void)
1125 int total_ir_length
= 0;
1131 total_ir_length
= 0;
1133 tap
= jtag_tap_next_enabled(tap
);
1137 total_ir_length
+= tap
->ir_length
;
1140 total_ir_length
+= 2;
1141 ir_test
= malloc(CEIL(total_ir_length
, 8));
1142 buf_set_ones(ir_test
, total_ir_length
);
1145 field
.num_bits
= total_ir_length
;
1146 field
.out_value
= ir_test
;
1147 field
.in_value
= ir_test
;
1150 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1151 jtag_execute_queue();
1157 tap
= jtag_tap_next_enabled(tap
);
1162 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1165 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1166 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
);
1169 return ERROR_JTAG_INIT_FAILED
;
1171 chain_pos
+= tap
->ir_length
;
1174 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1177 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1178 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
);
1181 return ERROR_JTAG_INIT_FAILED
;
1189 enum jtag_tap_cfg_param
{
1193 static Jim_Nvp nvp_config_opts
[] = {
1194 { .name
= "-event", .value
= JCFG_EVENT
},
1196 { .name
= NULL
, .value
= -1 }
1199 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1205 /* parse config or cget options */
1206 while (goi
->argc
> 0) {
1207 Jim_SetEmptyResult (goi
->interp
);
1209 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1211 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1217 if (goi
->argc
== 0) {
1218 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1222 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1224 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1228 if (goi
->isconfigure
) {
1229 if (goi
->argc
!= 1) {
1230 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1234 if (goi
->argc
!= 0) {
1235 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1241 jtag_tap_event_action_t
*jteap
;
1243 jteap
= tap
->event_action
;
1244 /* replace existing? */
1246 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1249 jteap
= jteap
->next
;
1252 if (goi
->isconfigure
) {
1253 if (jteap
== NULL
) {
1255 jteap
= calloc(1, sizeof (*jteap
));
1257 jteap
->event
= n
->value
;
1258 Jim_GetOpt_Obj( goi
, &o
);
1260 Jim_DecrRefCount(interp
, jteap
->body
);
1262 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1263 Jim_IncrRefCount(jteap
->body
);
1265 /* add to head of event list */
1266 jteap
->next
= tap
->event_action
;
1267 tap
->event_action
= jteap
;
1268 Jim_SetEmptyResult(goi
->interp
);
1271 if (jteap
== NULL
) {
1272 Jim_SetEmptyResult(goi
->interp
);
1274 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1281 } /* while (goi->argc) */
1287 static void jtag_tap_init(jtag_tap_t
*tap
)
1289 assert(0 != tap
->ir_length
);
1291 tap
->expected
= malloc(tap
->ir_length
);
1292 tap
->expected_mask
= malloc(tap
->ir_length
);
1293 tap
->cur_instr
= malloc(tap
->ir_length
);
1295 buf_set_u32(tap
->expected
, 0, tap
->ir_length
, tap
->ir_capture_value
);
1296 buf_set_u32(tap
->expected_mask
, 0, tap
->ir_length
, tap
->ir_capture_mask
);
1297 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1299 // place TAP in bypass mode
1301 // register the reset callback for the TAP
1302 jtag_register_event_callback(&jtag_reset_callback
, tap
);
1304 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1305 "irlen %d, capture: 0x%x mask: 0x%x", tap
->dotted_name
,
1306 tap
->abs_chain_position
, tap
->ir_length
,
1307 tap
->ir_capture_value
, tap
->ir_capture_mask
);
1311 static void jtag_tap_free(jtag_tap_t
*tap
)
1313 /// @todo is anything missing? no memory leaks please
1314 free((void *)tap
->expected_ids
);
1315 free((void *)tap
->chip
);
1316 free((void *)tap
->tapname
);
1317 free((void *)tap
->dotted_name
);
1321 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1330 const Jim_Nvp opts
[] = {
1331 #define NTAP_OPT_IRLEN 0
1332 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1333 #define NTAP_OPT_IRMASK 1
1334 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1335 #define NTAP_OPT_IRCAPTURE 2
1336 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1337 #define NTAP_OPT_ENABLED 3
1338 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1339 #define NTAP_OPT_DISABLED 4
1340 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1341 #define NTAP_OPT_EXPECTED_ID 5
1342 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1343 { .name
= NULL
, .value
= -1 },
1346 pTap
= malloc( sizeof(jtag_tap_t
) );
1347 memset( pTap
, 0, sizeof(*pTap
) );
1349 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1353 * we expect CHIP + TAP + OPTIONS
1355 if( goi
->argc
< 3 ){
1356 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1359 Jim_GetOpt_String( goi
, &cp
, NULL
);
1360 pTap
->chip
= strdup(cp
);
1362 Jim_GetOpt_String( goi
, &cp
, NULL
);
1363 pTap
->tapname
= strdup(cp
);
1365 /* name + dot + name + null */
1366 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1368 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1369 pTap
->dotted_name
= cp
;
1371 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1372 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
1374 /* default is enabled */
1377 /* deal with options */
1378 #define NTREQ_IRLEN 1
1379 #define NTREQ_IRCAPTURE 2
1380 #define NTREQ_IRMASK 4
1382 /* clear them as we find them */
1383 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
1386 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
1388 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
1391 LOG_DEBUG("Processing option: %s", n
->name
);
1393 case NTAP_OPT_ENABLED
:
1396 case NTAP_OPT_DISABLED
:
1399 case NTAP_OPT_EXPECTED_ID
:
1401 u32
*new_expected_ids
;
1403 e
= Jim_GetOpt_Wide( goi
, &w
);
1405 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
1409 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
1410 if (new_expected_ids
== NULL
) {
1411 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1415 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
1417 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
1419 free(pTap
->expected_ids
);
1420 pTap
->expected_ids
= new_expected_ids
;
1421 pTap
->expected_ids_cnt
++;
1424 case NTAP_OPT_IRLEN
:
1425 case NTAP_OPT_IRMASK
:
1426 case NTAP_OPT_IRCAPTURE
:
1427 e
= Jim_GetOpt_Wide( goi
, &w
);
1429 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
1432 if( (w
< 0) || (w
> 0xffff) ){
1434 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
1435 n
->name
, (int)(w
), (int)(w
));
1439 case NTAP_OPT_IRLEN
:
1440 pTap
->ir_length
= w
;
1441 reqbits
&= (~(NTREQ_IRLEN
));
1443 case NTAP_OPT_IRMASK
:
1444 pTap
->ir_capture_mask
= w
;
1445 reqbits
&= (~(NTREQ_IRMASK
));
1447 case NTAP_OPT_IRCAPTURE
:
1448 pTap
->ir_capture_value
= w
;
1449 reqbits
&= (~(NTREQ_IRCAPTURE
));
1452 } /* switch(n->value) */
1453 } /* while( goi->argc ) */
1455 /* Did all the required option bits get cleared? */
1458 jtag_tap_init(pTap
);
1462 Jim_SetResult_sprintf(goi
->interp
,
1463 "newtap: %s missing required parameters",
1465 jtag_tap_free(pTap
);
1469 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1475 struct command_context_s
*context
;
1479 JTAG_CMD_INIT_RESET
,
1482 JTAG_CMD_TAPDISABLE
,
1483 JTAG_CMD_TAPISENABLED
,
1488 const Jim_Nvp jtag_cmds
[] = {
1489 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
1490 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
1491 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
1492 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
1493 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
1494 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
1495 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
1496 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
1498 { .name
= NULL
, .value
= -1 },
1501 context
= Jim_GetAssocData(interp
, "context");
1502 /* go past the command */
1503 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
1505 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
1507 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
1510 Jim_SetEmptyResult( goi
.interp
);
1512 case JTAG_CMD_INTERFACE
:
1513 /* return the name of the interface */
1514 /* TCL code might need to know the exact type... */
1515 /* FUTURE: we allow this as a means to "set" the interface. */
1516 if( goi
.argc
!= 0 ){
1517 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1520 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
1522 case JTAG_CMD_INIT_RESET
:
1523 if( goi
.argc
!= 0 ){
1524 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
1527 e
= jtag_init_reset(context
);
1528 if( e
!= ERROR_OK
){
1529 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
1533 case JTAG_CMD_NEWTAP
:
1534 return jim_newtap_cmd( &goi
);
1536 case JTAG_CMD_TAPISENABLED
:
1537 case JTAG_CMD_TAPENABLE
:
1538 case JTAG_CMD_TAPDISABLE
:
1539 if( goi
.argc
!= 1 ){
1540 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
1546 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
1551 case JTAG_CMD_TAPISENABLED
:
1554 case JTAG_CMD_TAPENABLE
:
1555 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
1559 case JTAG_CMD_TAPDISABLE
:
1560 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
1565 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
1572 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
1579 Jim_GetOpt_Obj(&goi
, &o
);
1580 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1585 goi
.isconfigure
= 0;
1586 return jtag_tap_configure_cmd( &goi
, t
);
1590 case JTAG_CMD_CONFIGURE
:
1592 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
1599 Jim_GetOpt_Obj(&goi
, &o
);
1600 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
1605 goi
.isconfigure
= 1;
1606 return jtag_tap_configure_cmd( &goi
, t
);
1613 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1615 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
1617 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
1618 COMMAND_CONFIG
, "try to configure interface");
1619 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
1620 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
1621 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
1622 COMMAND_ANY
, "set maximum jtag speed (if supported); "
1623 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1624 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
1625 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1626 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
1628 "[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]");
1629 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
1630 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1631 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
1632 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1634 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
1635 COMMAND_EXEC
, "print current scan chain configuration");
1637 register_command(cmd_ctx
, NULL
, "endstate", handle_endstate_command
,
1638 COMMAND_EXEC
, "finish JTAG operations in <tap_state>");
1639 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
1640 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
1641 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
1642 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
1643 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
1644 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1645 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1646 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
1648 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
1649 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
1650 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
1651 COMMAND_ANY
, "verify value capture <enable|disable>");
1652 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
1653 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
1657 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
1662 if (!jtag_interface
)
1664 /* nothing was previously specified by "interface" command */
1665 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1666 return ERROR_JTAG_INVALID_INTERFACE
;
1670 jtag_interface
->khz(jtag_get_speed_khz(), &jtag_speed
);
1674 if (jtag_interface
->init() != ERROR_OK
)
1675 return ERROR_JTAG_INIT_FAILED
;
1677 jtag
= jtag_interface
;
1681 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
1686 LOG_DEBUG("Init JTAG chain");
1688 tap
= jtag_tap_next_enabled(NULL
);
1690 LOG_ERROR("There are no enabled taps?");
1691 return ERROR_JTAG_INIT_FAILED
;
1695 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
1698 /* examine chain first, as this could discover the real chain layout */
1699 if (jtag_examine_chain() != ERROR_OK
)
1701 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1704 if (jtag_validate_chain() != ERROR_OK
)
1706 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1712 int jtag_interface_quit(void)
1714 if (!jtag
|| !jtag
->quit
)
1717 // close the JTAG interface
1718 int result
= jtag
->quit();
1719 if (ERROR_OK
!= result
)
1720 LOG_ERROR("failed: %d", result
);
1726 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
1730 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1733 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1735 /* Reset can happen after a power cycle.
1737 * Ideally we would only assert TRST or run RESET before the target reset.
1739 * However w/srst_pulls_trst, trst is asserted together with the target
1740 * reset whether we want it or not.
1742 * NB! Some targets have JTAG circuitry disabled until a
1743 * trst & srst has been asserted.
1745 * NB! here we assume nsrst/ntrst delay are sufficient!
1747 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1750 jtag_add_reset(1, 0); /* RESET or TRST */
1751 if (jtag_reset_config
& RESET_HAS_SRST
)
1753 jtag_add_reset(1, 1);
1754 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
1755 jtag_add_reset(0, 1);
1757 jtag_add_reset(0, 0);
1758 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
1761 /* Check that we can communication on the JTAG chain + eventually we want to
1762 * be able to perform enumeration only after OpenOCD has started
1763 * telnet and GDB server
1765 * That would allow users to more easily perform any magic they need to before
1768 return jtag_init_inner(cmd_ctx
);
1771 int jtag_init(struct command_context_s
*cmd_ctx
)
1774 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
1776 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
1780 return jtag_init_reset(cmd_ctx
);
1783 void jtag_set_speed_khz(unsigned khz
)
1787 unsigned jtag_get_speed_khz(void)
1792 static int default_khz(int khz
, int *jtag_speed
)
1794 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1798 static int default_speed_div(int speed
, int *khz
)
1800 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1804 static int default_power_dropout(int *dropout
)
1806 *dropout
=0; /* by default we can't detect power dropout */
1810 static int default_srst_asserted(int *srst_asserted
)
1812 *srst_asserted
=0; /* by default we can't detect srst asserted */
1816 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1821 /* check whether the interface is already configured */
1824 LOG_WARNING("Interface already configured, ignoring");
1828 /* interface name is a mandatory argument */
1829 if (argc
< 1 || args
[0][0] == '\0')
1831 return ERROR_COMMAND_SYNTAX_ERROR
;
1834 for (i
=0; jtag_interfaces
[i
]; i
++)
1836 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
1838 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
1843 jtag_interface
= jtag_interfaces
[i
];
1845 if (jtag_interface
->khz
== NULL
)
1847 jtag_interface
->khz
= default_khz
;
1849 if (jtag_interface
->speed_div
== NULL
)
1851 jtag_interface
->speed_div
= default_speed_div
;
1853 if (jtag_interface
->power_dropout
== NULL
)
1855 jtag_interface
->power_dropout
= default_power_dropout
;
1857 if (jtag_interface
->srst_asserted
== NULL
)
1859 jtag_interface
->srst_asserted
= default_srst_asserted
;
1866 /* no valid interface was found (i.e. the configuration option,
1867 * didn't match one of the compiled-in interfaces
1869 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
1870 LOG_ERROR("compiled-in jtag interfaces:");
1871 for (i
= 0; jtag_interfaces
[i
]; i
++)
1873 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
1876 return ERROR_JTAG_INVALID_INTERFACE
;
1879 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1883 Jim_Obj
*newargs
[ 10 ];
1886 * argv[-1] = command
1887 * argv[ 0] = ir length
1888 * argv[ 1] = ir capture
1889 * argv[ 2] = ir mask
1890 * argv[ 3] = not actually used by anything but in the docs
1894 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1897 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1898 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1902 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1903 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1904 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1905 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
1907 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
1908 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
1909 sprintf( buf
, "chip%d", jtag_tap_count() );
1910 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
1911 sprintf( buf
, "tap%d", jtag_tap_count() );
1912 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
1913 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
1914 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
1915 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
1916 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
1917 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
1918 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
1920 command_print( cmd_ctx
, "NEW COMMAND:");
1921 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
1922 Jim_GetString( newargs
[0], NULL
),
1923 Jim_GetString( newargs
[1], NULL
),
1924 Jim_GetString( newargs
[2], NULL
),
1925 Jim_GetString( newargs
[3], NULL
),
1926 Jim_GetString( newargs
[4], NULL
),
1927 Jim_GetString( newargs
[5], NULL
),
1928 Jim_GetString( newargs
[6], NULL
),
1929 Jim_GetString( newargs
[7], NULL
),
1930 Jim_GetString( newargs
[8], NULL
),
1931 Jim_GetString( newargs
[9], NULL
) );
1933 e
= jim_jtag_command( interp
, 10, newargs
);
1935 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
1940 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1944 tap
= jtag_all_taps();
1945 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1946 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
1949 u32 expected
, expected_mask
, cur_instr
, ii
;
1950 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
1951 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
1952 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
1954 command_print(cmd_ctx
,
1955 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1956 tap
->abs_chain_position
,
1958 tap
->enabled
? 'Y' : 'n',
1960 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
1966 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
1967 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
1968 tap
->expected_ids
[ii
]);
1971 tap
= tap
->next_tap
;
1977 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1983 return ERROR_COMMAND_SYNTAX_ERROR
;
1985 /* Original versions cared about the order of these tokens:
1986 * reset_config signals [combination [trst_type [srst_type]]]
1987 * They also clobbered the previous configuration even on error.
1989 * Here we don't care about the order, and only change values
1990 * which have been explicitly specified.
1992 for (; argc
; argc
--, args
++) {
1997 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
1998 if (strcmp(*args
, "none") == 0)
2000 else if (strcmp(*args
, "trst_only") == 0)
2001 tmp
= RESET_HAS_TRST
;
2002 else if (strcmp(*args
, "srst_only") == 0)
2003 tmp
= RESET_HAS_SRST
;
2004 else if (strcmp(*args
, "trst_and_srst") == 0)
2005 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
2009 LOG_ERROR("extra reset_config %s spec (%s)",
2011 return ERROR_INVALID_ARGUMENTS
;
2016 /* combination (options for broken wiring) */
2017 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2018 if (strcmp(*args
, "separate") == 0)
2019 /* separate reset lines - default */;
2020 else if (strcmp(*args
, "srst_pulls_trst") == 0)
2021 tmp
|= RESET_SRST_PULLS_TRST
;
2022 else if (strcmp(*args
, "trst_pulls_srst") == 0)
2023 tmp
|= RESET_TRST_PULLS_SRST
;
2024 else if (strcmp(*args
, "combined") == 0)
2025 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2029 LOG_ERROR("extra reset_config %s spec (%s)",
2030 "combination", *args
);
2031 return ERROR_INVALID_ARGUMENTS
;
2036 /* trst_type (NOP without HAS_TRST) */
2037 m
= RESET_TRST_OPEN_DRAIN
;
2038 if (strcmp(*args
, "trst_open_drain") == 0)
2039 tmp
|= RESET_TRST_OPEN_DRAIN
;
2040 else if (strcmp(*args
, "trst_push_pull") == 0)
2041 /* push/pull from adapter - default */;
2045 LOG_ERROR("extra reset_config %s spec (%s)",
2046 "trst_type", *args
);
2047 return ERROR_INVALID_ARGUMENTS
;
2052 /* srst_type (NOP without HAS_SRST) */
2053 m
|= RESET_SRST_PUSH_PULL
;
2054 if (strcmp(*args
, "srst_push_pull") == 0)
2055 tmp
|= RESET_SRST_PUSH_PULL
;
2056 else if (strcmp(*args
, "srst_open_drain") == 0)
2057 /* open drain from adapter - default */;
2061 LOG_ERROR("extra reset_config %s spec (%s)",
2062 "srst_type", *args
);
2063 return ERROR_INVALID_ARGUMENTS
;
2068 /* caller provided nonsense; fail */
2069 LOG_ERROR("unknown reset_config flag (%s)", *args
);
2070 return ERROR_INVALID_ARGUMENTS
;
2073 /* Remember the bits which were specified (mask)
2074 * and their new values (new_cfg).
2080 /* clear previous values of those bits, save new values */
2081 jtag_reset_config
&= ~mask
;
2082 jtag_reset_config
|= new_cfg
;
2087 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2091 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2096 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
2102 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2106 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2111 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
2118 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2120 int retval
=ERROR_OK
;
2124 LOG_DEBUG("handle jtag speed");
2127 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2129 /* this command can be called during CONFIG,
2130 * in which case jtag isn't initialized */
2133 retval
=jtag
->speed(cur_speed
);
2135 } else if (argc
== 0)
2139 return ERROR_COMMAND_SYNTAX_ERROR
;
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
)
2148 int retval
=ERROR_OK
;
2149 LOG_DEBUG("handle jtag khz");
2154 jtag_set_speed_khz(strtoul(args
[0], NULL
, 0));
2157 LOG_DEBUG("have interface set up");
2159 if ((retval
=jtag
->khz(jtag_get_speed_khz(), &speed_div1
))!=ERROR_OK
)
2161 jtag_set_speed_khz(0);
2165 cur_speed
= jtag_speed
= speed_div1
;
2167 retval
=jtag
->speed(cur_speed
);
2176 return ERROR_COMMAND_SYNTAX_ERROR
;
2178 cur_speed
= jtag_get_speed_khz();
2182 if ((retval
=jtag
->speed_div(jtag_speed
, &cur_speed
))!=ERROR_OK
)
2187 command_print(cmd_ctx
, "%d kHz", cur_speed
);
2189 command_print(cmd_ctx
, "RCLK - adaptive");
2194 static int handle_endstate_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2197 return ERROR_COMMAND_SYNTAX_ERROR
;
2199 tap_state_t state
= tap_state_by_name(args
[0]);
2202 command_print( cmd_ctx
, "Invalid state name: %s\n", args
[0] );
2203 return ERROR_COMMAND_SYNTAX_ERROR
;
2205 jtag_set_end_state(state
);
2206 jtag_execute_queue();
2208 command_print(cmd_ctx
, "current endstate: %s",
2209 tap_state_name(cmd_queue_end_state
));
2214 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2221 return ERROR_COMMAND_SYNTAX_ERROR
;
2224 if (args
[0][0] == '1')
2226 else if (args
[0][0] == '0')
2230 return ERROR_COMMAND_SYNTAX_ERROR
;
2233 if (args
[1][0] == '1')
2235 else if (args
[1][0] == '0')
2239 return ERROR_COMMAND_SYNTAX_ERROR
;
2242 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2243 return ERROR_JTAG_INIT_FAILED
;
2245 jtag_add_reset(trst
, srst
);
2246 jtag_execute_queue();
2251 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2255 return ERROR_COMMAND_SYNTAX_ERROR
;
2258 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
2259 jtag_execute_queue();
2266 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2267 * should be stable ... and *NOT* a shift state, otherwise free-running
2268 * jtag clocks could change the values latched by the update state.
2270 static bool scan_is_safe(tap_state_t state
)
2285 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2288 scan_field_t
*fields
;
2290 tap_state_t endstate
;
2292 if ((argc
< 2) || (argc
% 2))
2294 return ERROR_COMMAND_SYNTAX_ERROR
;
2297 /* optional "-endstate" "statename" at the end of the arguments,
2298 * so that e.g. IRPAUSE can let us load the data register before
2299 * entering RUN/IDLE to execute the instruction we load here.
2301 endstate
= TAP_IDLE
;
2304 /* have at least one pair of numbers. */
2305 /* is last pair the magic text? */
2306 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2309 cpA
= args
[ argc
-1 ];
2310 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2311 cpS
= tap_state_name( endstate
);
2312 if( 0 == strcmp( cpA
, cpS
) ){
2316 if( endstate
>= TAP_NUM_STATES
){
2317 return ERROR_COMMAND_SYNTAX_ERROR
;
2319 if (!scan_is_safe(endstate
))
2320 LOG_WARNING("irscan with unsafe "
2321 "endstate \"%s\"", cpA
);
2322 /* found - remove the last 2 args */
2328 int num_fields
= argc
/ 2;
2330 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2332 for (i
= 0; i
< num_fields
; i
++)
2334 tap
= jtag_tap_by_string( args
[i
*2] );
2337 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2340 int field_size
= tap
->ir_length
;
2341 fields
[i
].tap
= tap
;
2342 fields
[i
].num_bits
= field_size
;
2343 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2344 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2345 fields
[i
].in_value
= NULL
;
2348 /* did we have an endstate? */
2349 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2351 int retval
=jtag_execute_queue();
2353 for (i
= 0; i
< num_fields
; i
++)
2354 free(fields
[i
].out_value
);
2361 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2364 scan_field_t
*fields
;
2366 int field_count
= 0;
2369 tap_state_t endstate
;
2372 * args[2] = num_bits
2373 * args[3] = hex string
2374 * ... repeat num bits and hex string ...
2377 * args[N-2] = "-endstate"
2378 * args[N-1] = statename
2380 if ((argc
< 4) || ((argc
% 2)!=0))
2382 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2386 endstate
= TAP_IDLE
;
2388 /* validate arguments as numbers */
2390 for (i
= 2; i
< argc
; i
+=2)
2395 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2396 /* If valid - try next arg */
2401 /* Not valid.. are we at the end? */
2402 if ( ((i
+2) != argc
) ){
2403 /* nope, then error */
2407 /* it could be: "-endstate FOO"
2408 * e.g. DRPAUSE so we can issue more instructions
2409 * before entering RUN/IDLE and executing them.
2412 /* get arg as a string. */
2413 cp
= Jim_GetString( args
[i
], NULL
);
2414 /* is it the magic? */
2415 if( 0 == strcmp( "-endstate", cp
) ){
2416 /* is the statename valid? */
2417 cp
= Jim_GetString( args
[i
+1], NULL
);
2419 /* see if it is a valid state name */
2420 endstate
= tap_state_by_name(cp
);
2422 /* update the error message */
2423 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
2425 if (!scan_is_safe(endstate
))
2426 LOG_WARNING("drscan with unsafe "
2427 "endstate \"%s\"", cp
);
2429 /* valid - so clear the error */
2431 /* and remove the last 2 args */
2436 /* Still an error? */
2438 return e
; /* too bad */
2440 } /* validate args */
2442 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
2447 num_fields
=(argc
-2)/2;
2448 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2449 for (i
= 2; i
< argc
; i
+=2)
2455 Jim_GetLong(interp
, args
[i
], &bits
);
2456 str
= Jim_GetString(args
[i
+1], &len
);
2458 fields
[field_count
].tap
= tap
;
2459 fields
[field_count
].num_bits
= bits
;
2460 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
2461 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
2462 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
2466 jtag_add_dr_scan(num_fields
, fields
, endstate
);
2468 retval
= jtag_execute_queue();
2469 if (retval
!= ERROR_OK
)
2471 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
2476 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
2477 for (i
= 2; i
< argc
; i
+=2)
2482 Jim_GetLong(interp
, args
[i
], &bits
);
2483 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
2484 free(fields
[field_count
].out_value
);
2486 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
2491 Jim_SetResult(interp
, list
);
2499 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2501 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
2507 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2511 if (strcmp(args
[0], "enable") == 0)
2513 jtag_verify_capture_ir
= 1;
2515 else if (strcmp(args
[0], "disable") == 0)
2517 jtag_verify_capture_ir
= 0;
2520 return ERROR_COMMAND_SYNTAX_ERROR
;
2522 } else if (argc
!= 0)
2524 return ERROR_COMMAND_SYNTAX_ERROR
;
2527 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
2532 void jtag_set_verify(bool enable
)
2534 jtag_verify
= enable
;
2537 bool jtag_will_verify()
2542 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2545 return ERROR_COMMAND_SYNTAX_ERROR
;
2549 if (strcmp(args
[0], "enable") == 0)
2550 jtag_set_verify(true);
2551 else if (strcmp(args
[0], "disable") == 0)
2552 jtag_set_verify(false);
2554 return ERROR_COMMAND_SYNTAX_ERROR
;
2557 const char *status
= jtag_will_verify() ? "enabled": "disabled";
2558 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
2564 int jtag_power_dropout(int *dropout
)
2566 return jtag
->power_dropout(dropout
);
2569 int jtag_srst_asserted(int *srst_asserted
)
2571 return jtag
->srst_asserted(srst_asserted
);
2574 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
2576 jtag_tap_event_action_t
* jteap
;
2579 jteap
= tap
->event_action
;
2583 if (jteap
->event
== e
) {
2585 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2588 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
2589 Jim_GetString(jteap
->body
, NULL
) );
2590 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
2591 Jim_PrintErrorMessage(interp
);
2595 jteap
= jteap
->next
;
2599 LOG_DEBUG( "event %d %s - no action",
2601 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
2605 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2608 return ERROR_COMMAND_SYNTAX_ERROR
;
2613 if (strcmp(args
[0], "short") == 0)
2614 use_new_table
= true;
2615 else if (strcmp(args
[0], "long") == 0)
2616 use_new_table
= false;
2618 return ERROR_COMMAND_SYNTAX_ERROR
;
2620 tap_use_new_tms_table(use_new_table
);
2623 command_print(cmd_ctx
, "tms sequence is %s",
2624 tap_uses_new_tms_table() ? "short": "long");
2630 * Function jtag_add_statemove
2631 * moves from the current state to the goal \a state. This needs
2632 * to be handled according to the xsvf spec, see the XSTATE command
2635 int jtag_add_statemove(tap_state_t goal_state
)
2637 int retval
= ERROR_OK
;
2639 tap_state_t moves
[8];
2640 tap_state_t cur_state
= cmd_queue_cur_state
;
2645 LOG_DEBUG( "cur_state=%s goal_state=%s",
2646 tap_state_name(cur_state
),
2647 tap_state_name(goal_state
) );
2650 /* From the XSVF spec, pertaining to XSTATE:
2652 For special states known as stable states (Test-Logic-Reset,
2653 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2654 predefined TAP state paths when the starting state is a stable state and
2655 when the XSTATE specifies a new stable state (see the STATE command in
2656 the [Ref 5] for the TAP state paths between stable states). For
2657 non-stable states, XSTATE should specify a state that is only one TAP
2658 state transition distance from the current TAP state to avoid undefined
2659 TAP state paths. A sequence of multiple XSTATE commands can be issued to
2660 transition the TAP through a specific state path.
2663 if (goal_state
==cur_state
)
2664 ; /* nothing to do */
2666 else if( goal_state
==TAP_RESET
)
2671 else if( tap_is_state_stable(cur_state
) && tap_is_state_stable(goal_state
) )
2673 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
2674 spec, then this code is not fully conformant to the xsvf spec. This
2675 puts a burden on tap_get_tms_path() function from the xsvf spec.
2676 If in doubt, you should confirm that that burden is being met.
2679 tms_bits
= tap_get_tms_path(cur_state
, goal_state
);
2680 tms_count
= tap_get_tms_path_len(cur_state
, goal_state
);
2682 assert( (unsigned) tms_count
< DIM(moves
) );
2684 for (i
=0; i
<tms_count
; i
++, tms_bits
>>=1)
2686 bool bit
= tms_bits
& 1;
2688 cur_state
= tap_state_transition(cur_state
, bit
);
2689 moves
[i
] = cur_state
;
2692 jtag_add_pathmove(tms_count
, moves
);
2695 /* else state must be immediately reachable in one clock cycle, and does not
2696 need to be a stable state.
2698 else if( tap_state_transition(cur_state
, true) == goal_state
2699 || tap_state_transition(cur_state
, false) == goal_state
)
2701 /* move a single state */
2702 moves
[0] = goal_state
;
2703 jtag_add_pathmove( 1, moves
);
2708 retval
= ERROR_FAIL
;
2714 void jtag_set_nsrst_delay(unsigned delay
)
2716 jtag_nsrst_delay
= delay
;
2718 void jtag_set_ntrst_delay(unsigned delay
)
2720 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)