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 ***************************************************************************/
38 int jtag_flush_queue_count
; /* count # of flushes for profiling / debugging purposes */
40 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
),
41 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
);
43 /* note that this is not marked as static as it must be available from outside jtag.c for those
44 that implement the jtag_xxx() minidriver layer
46 int jtag_error
=ERROR_OK
;
48 typedef struct cmd_queue_page_s
52 struct cmd_queue_page_s
*next
;
55 #define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
56 static cmd_queue_page_t
*cmd_queue_pages
= NULL
;
58 char* jtag_event_strings
[] =
60 "JTAG controller reset (RESET or TRST)"
63 const Jim_Nvp nvp_jtag_tap_event
[] = {
64 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
65 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
67 { .name
= NULL
, .value
= -1 }
73 #ifndef HAVE_JTAG_MINIDRIVER_H
74 struct jtag_callback_entry
76 struct jtag_callback_entry
*next
;
78 jtag_callback_t callback
;
80 jtag_callback_data_t data1
;
81 jtag_callback_data_t data2
;
82 jtag_callback_data_t data3
;
86 static struct jtag_callback_entry
*jtag_callback_queue_head
= NULL
;
87 static struct jtag_callback_entry
*jtag_callback_queue_tail
= NULL
;
91 jtag_command_t
*jtag_command_queue
= NULL
;
92 jtag_command_t
**last_command_pointer
= &jtag_command_queue
;
93 static jtag_tap_t
*jtag_all_taps
= NULL
;
95 enum reset_types jtag_reset_config
= RESET_NONE
;
96 tap_state_t cmd_queue_end_state
= TAP_RESET
;
97 tap_state_t cmd_queue_cur_state
= TAP_RESET
;
99 int jtag_verify_capture_ir
= 1;
102 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
103 static int jtag_nsrst_delay
= 0; /* default to no nSRST delay */
104 static int jtag_ntrst_delay
= 0; /* default to no nTRST delay */
106 /* maximum number of JTAG devices expected in the chain
108 #define JTAG_MAX_CHAIN_SIZE 20
110 /* callbacks to inform high-level handlers about JTAG state changes */
111 jtag_event_callback_t
*jtag_event_callbacks
;
114 static int speed_khz
= 0;
115 /* flag if the kHz speed was defined */
116 static int hasKHz
= 0;
118 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
121 #if BUILD_ECOSBOARD == 1
122 extern jtag_interface_t zy1000_interface
;
125 #if BUILD_PARPORT == 1
126 extern jtag_interface_t parport_interface
;
130 extern jtag_interface_t dummy_interface
;
133 #if BUILD_FT2232_FTD2XX == 1
134 extern jtag_interface_t ft2232_interface
;
137 #if BUILD_FT2232_LIBFTDI == 1
138 extern jtag_interface_t ft2232_interface
;
141 #if BUILD_AMTJTAGACCEL == 1
142 extern jtag_interface_t amt_jtagaccel_interface
;
145 #if BUILD_EP93XX == 1
146 extern jtag_interface_t ep93xx_interface
;
149 #if BUILD_AT91RM9200 == 1
150 extern jtag_interface_t at91rm9200_interface
;
153 #if BUILD_GW16012 == 1
154 extern jtag_interface_t gw16012_interface
;
157 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
158 extern jtag_interface_t presto_interface
;
161 #if BUILD_USBPROG == 1
162 extern jtag_interface_t usbprog_interface
;
166 extern jtag_interface_t jlink_interface
;
169 #if BUILD_VSLLINK == 1
170 extern jtag_interface_t vsllink_interface
;
174 extern jtag_interface_t rlink_interface
;
177 #if BUILD_ARMJTAGEW == 1
178 extern jtag_interface_t armjtagew_interface
;
181 jtag_interface_t
*jtag_interfaces
[] = {
182 #if BUILD_ECOSBOARD == 1
185 #if BUILD_PARPORT == 1
191 #if BUILD_FT2232_FTD2XX == 1
194 #if BUILD_FT2232_LIBFTDI == 1
197 #if BUILD_AMTJTAGACCEL == 1
198 &amt_jtagaccel_interface
,
200 #if BUILD_EP93XX == 1
203 #if BUILD_AT91RM9200 == 1
204 &at91rm9200_interface
,
206 #if BUILD_GW16012 == 1
209 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
212 #if BUILD_USBPROG == 1
218 #if BUILD_VSLLINK == 1
224 #if BUILD_ARMJTAGEW == 1
225 &armjtagew_interface
,
230 jtag_interface_t
*jtag
= NULL
;
233 static jtag_interface_t
*jtag_interface
= NULL
;
236 /* forward declarations */
237 //void jtag_add_pathmove(int num_states, tap_state_t *path);
238 //void jtag_add_runtest(int num_cycles, tap_state_t endstate);
239 //void jtag_add_end_state(tap_state_t endstate);
240 //void jtag_add_sleep(u32 us);
241 //int jtag_execute_queue(void);
242 static tap_state_t
tap_state_by_name(const char *name
);
245 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
246 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
247 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
248 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
249 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
250 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
251 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
253 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
255 static int handle_endstate_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
256 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
257 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
258 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
259 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
260 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
262 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
263 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
264 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
266 jtag_tap_t
*jtag_AllTaps(void)
268 return jtag_all_taps
;
271 int jtag_NumTotalTaps(void)
285 int jtag_NumEnabledTaps(void)
301 jtag_tap_t
*jtag_TapByString( const char *s
)
309 if( 0 == strcmp( t
->dotted_name
, s
) ){
315 /* backup plan is by number */
317 /* ok - is "s" a number? */
319 n
= strtol( s
, &cp
, 0 );
320 if( (s
!= cp
) && (*cp
== 0) ){
322 t
= jtag_TapByAbsPosition(n
);
328 jtag_tap_t
* jtag_TapByJimObj( Jim_Interp
*interp
, Jim_Obj
*o
)
333 cp
= Jim_GetString( o
, NULL
);
338 t
= jtag_TapByString( cp
);
341 Jim_SetResult_sprintf(interp
,"Tap: %s is unknown", cp
);
346 /* returns a pointer to the n-th device in the scan chain */
347 jtag_tap_t
* jtag_TapByAbsPosition( int n
)
355 while( t
&& (n
> 0)) {
362 int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
)
364 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
366 if (callback
== NULL
)
368 return ERROR_INVALID_ARGUMENTS
;
373 while ((*callbacks_p
)->next
)
374 callbacks_p
= &((*callbacks_p
)->next
);
375 callbacks_p
= &((*callbacks_p
)->next
);
378 (*callbacks_p
) = malloc(sizeof(jtag_event_callback_t
));
379 (*callbacks_p
)->callback
= callback
;
380 (*callbacks_p
)->priv
= priv
;
381 (*callbacks_p
)->next
= NULL
;
386 int jtag_unregister_event_callback(int (*callback
)(enum jtag_event event
, void *priv
))
388 jtag_event_callback_t
**callbacks_p
= &jtag_event_callbacks
;
390 if (callback
== NULL
)
392 return ERROR_INVALID_ARGUMENTS
;
397 jtag_event_callback_t
**next
= &((*callbacks_p
)->next
);
398 if ((*callbacks_p
)->callback
== callback
)
401 *callbacks_p
= *next
;
409 int jtag_call_event_callbacks(enum jtag_event event
)
411 jtag_event_callback_t
*callback
= jtag_event_callbacks
;
413 LOG_DEBUG("jtag event: %s", jtag_event_strings
[event
]);
417 callback
->callback(event
, callback
->priv
);
418 callback
= callback
->next
;
424 /* returns a pointer to the pointer of the last command in queue
425 * this may be a pointer to the root pointer (jtag_command_queue)
426 * or to the next member of the last but one command
428 jtag_command_t
** jtag_get_last_command_p(void)
430 /* jtag_command_t *cmd = jtag_command_queue;
436 return &jtag_command_queue;
440 return last_command_pointer
;
444 void jtag_queue_command(jtag_command_t
* cmd
)
446 jtag_command_t
**last_cmd
;
448 last_cmd
= jtag_get_last_command_p();
452 (*last_cmd
)->next
= NULL
;
454 last_command_pointer
= &((*last_cmd
)->next
);
458 void* cmd_queue_alloc(size_t size
)
460 cmd_queue_page_t
**p_page
= &cmd_queue_pages
;
466 * We align/round the *SIZE* per below
467 * so that all pointers returned by
468 * this function are reasonably well
471 * If we did not, then an "odd-length" request would cause the
472 * *next* allocation to be at an *odd* address, and because
473 * this function has the same type of api as malloc() - we
474 * must also return pointers that have the same type of
477 * What I do not/have is a reasonable portable means
480 * The solution here, is based on these suggestions.
481 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
484 union worse_case_align
{
490 #define ALIGN_SIZE (sizeof(union worse_case_align))
492 /* The alignment process. */
493 size
= (size
+ ALIGN_SIZE
-1) & (~(ALIGN_SIZE
-1));
498 while ((*p_page
)->next
)
499 p_page
= &((*p_page
)->next
);
500 if (CMD_QUEUE_PAGE_SIZE
- (*p_page
)->used
< size
)
501 p_page
= &((*p_page
)->next
);
506 *p_page
= malloc(sizeof(cmd_queue_page_t
));
508 (*p_page
)->address
= malloc(CMD_QUEUE_PAGE_SIZE
);
509 (*p_page
)->next
= NULL
;
512 offset
= (*p_page
)->used
;
513 (*p_page
)->used
+= size
;
515 t
=(u8
*)((*p_page
)->address
);
519 void cmd_queue_free(void)
521 cmd_queue_page_t
*page
= cmd_queue_pages
;
525 cmd_queue_page_t
*last
= page
;
531 cmd_queue_pages
= NULL
;
534 static void jtag_prelude1(void)
538 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
539 jtag_error
=ERROR_JTAG_TRST_ASSERTED
;
543 if (cmd_queue_end_state
== TAP_RESET
)
544 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
547 static void jtag_prelude(tap_state_t state
)
551 if (state
!= TAP_INVALID
)
552 jtag_add_end_state(state
);
554 cmd_queue_cur_state
= cmd_queue_end_state
;
557 void jtag_add_ir_scan_noverify(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
562 retval
=interface_jtag_add_ir_scan(in_num_fields
, in_fields
, cmd_queue_end_state
);
563 if (retval
!=ERROR_OK
)
569 void jtag_add_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
571 if (jtag_verify
&&jtag_verify_capture_ir
)
573 /* 8 x 32 bit id's is enough for all invoations */
575 for (int j
= 0; j
< in_num_fields
; j
++)
577 in_fields
[j
].check_value
=NULL
;
578 in_fields
[j
].check_mask
=NULL
;
579 /* if we are to run a verification of the ir scan, we need to get the input back.
580 * We may have to allocate space if the caller didn't ask for the input back.
582 in_fields
[j
].check_value
=in_fields
[j
].tap
->expected
;
583 in_fields
[j
].check_mask
=in_fields
[j
].tap
->expected_mask
;
585 jtag_add_scan_check(jtag_add_ir_scan_noverify
, in_num_fields
, in_fields
, state
);
588 jtag_add_ir_scan_noverify(in_num_fields
, in_fields
, state
);
593 * Generate a list of scan fields with one entry for each TAP.
595 * If the input field list contains an instruction value for a TAP then that is used
596 * otherwise the TAP is set to bypass.
599 int MINIDRIVER(interface_jtag_add_ir_scan
)(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
604 int num_taps
= jtag_NumEnabledTaps();
606 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
607 scan_command_t
* scan
= cmd_queue_alloc(sizeof(scan_command_t
));
609 jtag_queue_command(cmd
);
611 cmd
->type
= JTAG_SCAN
;
612 cmd
->cmd
.scan
= scan
;
614 scan
->ir_scan
= true;
615 scan
->num_fields
= num_taps
; /* one field per device */
616 scan
->fields
= cmd_queue_alloc(num_taps
* sizeof(scan_field_t
));
617 scan
->end_state
= state
;
624 /* do this here so it is not forgotten */
625 tap
= jtag_NextEnabledTap(tap
);
631 assert(nth_tap
< num_taps
);
633 size_t scan_size
= tap
->ir_length
;
634 scan
->fields
[nth_tap
].tap
= tap
;
635 scan
->fields
[nth_tap
].num_bits
= scan_size
;
636 scan
->fields
[nth_tap
].in_value
= NULL
; /* do not collect input for tap's in bypass */
638 /* search the list */
639 for (int j
= 0; j
< in_num_fields
; j
++)
641 if (tap
== in_fields
[j
].tap
)
644 scan
->fields
[nth_tap
].in_value
= in_fields
[j
].in_value
;
645 scan
->fields
[nth_tap
].out_value
= buf_cpy(in_fields
[j
].out_value
, cmd_queue_alloc(CEIL(scan_size
, 8)), scan_size
);
654 /* if a tap isn't listed, set it to BYPASS */
655 scan
->fields
[nth_tap
].out_value
= buf_set_ones(cmd_queue_alloc(CEIL(scan_size
, 8)), scan_size
);
659 /* update device information */
660 buf_cpy(scan
->fields
[nth_tap
].out_value
, tap
->cur_instr
, scan_size
);
663 assert(nth_tap
== (num_taps
- 1));
668 void jtag_add_plain_ir_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
674 retval
=interface_jtag_add_plain_ir_scan(in_num_fields
, in_fields
, cmd_queue_end_state
);
675 if (retval
!=ERROR_OK
)
679 int MINIDRIVER(interface_jtag_add_plain_ir_scan
)(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
682 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
683 scan_command_t
* scan
= cmd_queue_alloc(sizeof(scan_command_t
));
685 jtag_queue_command(cmd
);
687 cmd
->type
= JTAG_SCAN
;
688 cmd
->cmd
.scan
= scan
;
690 scan
->ir_scan
= true;
691 scan
->num_fields
= in_num_fields
;
692 scan
->fields
= cmd_queue_alloc(in_num_fields
* sizeof(scan_field_t
));
693 scan
->end_state
= state
;
695 for (int i
= 0; i
< in_num_fields
; i
++)
697 int num_bits
= in_fields
[i
].num_bits
;
698 int num_bytes
= CEIL(in_fields
[i
].num_bits
, 8);
699 scan
->fields
[i
].tap
= in_fields
[i
].tap
;
700 scan
->fields
[i
].num_bits
= num_bits
;
701 scan
->fields
[i
].out_value
= buf_cpy(in_fields
[i
].out_value
, cmd_queue_alloc(num_bytes
), num_bits
);
702 scan
->fields
[i
].in_value
= in_fields
[i
].in_value
;
708 void jtag_add_dr_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
714 retval
=interface_jtag_add_dr_scan(in_num_fields
, in_fields
, cmd_queue_end_state
);
715 if (retval
!=ERROR_OK
)
720 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
);
722 static int jtag_check_value_mask_callback(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
724 return jtag_check_value_inner(in
, (u8
*)data1
, (u8
*)data2
, (int)data3
);
727 static void jtag_add_scan_check(void (*jtag_add_scan
)(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
),
728 int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
730 for (int i
= 0; i
< in_num_fields
; i
++)
732 in_fields
[i
].allocated
= 0;
733 in_fields
[i
].modified
= 0;
734 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
== NULL
))
736 in_fields
[i
].modified
= 1;
737 /* we need storage space... */
738 #ifdef HAVE_JTAG_MINIDRIVER_H
739 if (in_fields
[i
].num_bits
<= 32)
741 /* This is enough space and we're executing this synchronously */
742 in_fields
[i
].in_value
= in_fields
[i
].intmp
;
745 in_fields
[i
].in_value
= (u8
*)malloc(CEIL(in_fields
[i
].num_bits
, 8));
746 in_fields
[i
].allocated
= 1;
749 in_fields
[i
].in_value
= (u8
*)cmd_queue_alloc(CEIL(in_fields
[i
].num_bits
, 8));
754 jtag_add_scan(in_num_fields
, in_fields
, state
);
756 for (int i
= 0; i
< in_num_fields
; i
++)
758 if ((in_fields
[i
].check_value
!= NULL
) && (in_fields
[i
].in_value
!= NULL
))
760 /* this is synchronous for a minidriver */
761 jtag_add_callback4(jtag_check_value_mask_callback
, in_fields
[i
].in_value
,
762 (jtag_callback_data_t
)in_fields
[i
].check_value
,
763 (jtag_callback_data_t
)in_fields
[i
].check_mask
,
764 (jtag_callback_data_t
)in_fields
[i
].num_bits
);
766 if (in_fields
[i
].allocated
)
768 free(in_fields
[i
].in_value
);
770 if (in_fields
[i
].modified
)
772 in_fields
[i
].in_value
= NULL
;
777 void jtag_add_dr_scan_check(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
781 jtag_add_scan_check(jtag_add_dr_scan
, in_num_fields
, in_fields
, state
);
784 jtag_add_dr_scan(in_num_fields
, in_fields
, state
);
788 int MINIDRIVER(interface_jtag_add_dr_scan
)(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
792 int bypass_devices
= 0;
798 /* count devices in bypass */
802 tap
= jtag_NextEnabledTap(tap
);
811 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
812 scan_command_t
* scan
= cmd_queue_alloc(sizeof(scan_command_t
));
814 jtag_queue_command(cmd
);
816 cmd
->type
= JTAG_SCAN
;
817 cmd
->cmd
.scan
= scan
;
819 scan
->ir_scan
= false;
820 scan
->num_fields
= in_num_fields
+ bypass_devices
;
821 scan
->fields
= cmd_queue_alloc((in_num_fields
+ bypass_devices
) * sizeof(scan_field_t
));
822 scan
->end_state
= state
;
828 tap
= jtag_NextEnabledTap(tap
);
833 scan
->fields
[field_count
].tap
= tap
;
835 for (j
= 0; j
< in_num_fields
; j
++)
837 if (tap
== in_fields
[j
].tap
)
840 scan_size
= in_fields
[j
].num_bits
;
841 scan
->fields
[field_count
].num_bits
= scan_size
;
842 scan
->fields
[field_count
].out_value
= buf_cpy(in_fields
[j
].out_value
, cmd_queue_alloc(CEIL(scan_size
, 8)), scan_size
);
843 scan
->fields
[field_count
].in_value
= in_fields
[j
].in_value
;
849 #ifdef _DEBUG_JTAG_IO_
850 /* if a device isn't listed, the BYPASS register should be selected */
853 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
857 /* program the scan field to 1 bit length, and ignore it's value */
858 scan
->fields
[field_count
].num_bits
= 1;
859 scan
->fields
[field_count
].out_value
= NULL
;
860 scan
->fields
[field_count
].in_value
= NULL
;
865 #ifdef _DEBUG_JTAG_IO_
866 /* if a device is listed, the BYPASS register must not be selected */
869 LOG_ERROR("BUG: scan data for a device in BYPASS");
876 /* field_count represents the true number of fields setup*/
877 scan
->num_fields
= field_count
;
881 void MINIDRIVER(interface_jtag_add_dr_out
)(jtag_tap_t
*target_tap
,
885 tap_state_t end_state
)
890 int bypass_devices
= 0;
894 /* count devices in bypass */
898 tap
= jtag_NextEnabledTap(tap
);
907 /* allocate memory for a new list member */
908 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
910 jtag_queue_command(cmd
);
912 cmd
->type
= JTAG_SCAN
;
914 /* allocate memory for dr scan command */
915 cmd
->cmd
.scan
= cmd_queue_alloc(sizeof(scan_command_t
));
916 cmd
->cmd
.scan
->ir_scan
= false;
917 cmd
->cmd
.scan
->num_fields
= in_num_fields
+ bypass_devices
;
918 cmd
->cmd
.scan
->fields
= cmd_queue_alloc((in_num_fields
+ bypass_devices
) * sizeof(scan_field_t
));
919 cmd
->cmd
.scan
->end_state
= end_state
;
924 tap
= jtag_NextEnabledTap(tap
);
929 cmd
->cmd
.scan
->fields
[field_count
].tap
= tap
;
931 if (tap
== target_tap
)
934 #ifdef _DEBUG_JTAG_IO_
935 /* if a device is listed, the BYPASS register must not be selected */
938 LOG_ERROR("BUG: scan data for a device in BYPASS");
942 for (j
= 0; j
< in_num_fields
; j
++)
945 scan_size
= num_bits
[j
];
946 buf_set_u32(out_value
, 0, scan_size
, value
[j
]);
947 cmd
->cmd
.scan
->fields
[field_count
].num_bits
= scan_size
;
948 cmd
->cmd
.scan
->fields
[field_count
].out_value
= buf_cpy(out_value
, cmd_queue_alloc(CEIL(scan_size
, 8)), scan_size
);
949 cmd
->cmd
.scan
->fields
[field_count
].in_value
= NULL
;
954 #ifdef _DEBUG_JTAG_IO_
955 /* if a device isn't listed, the BYPASS register should be selected */
958 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
962 /* program the scan field to 1 bit length, and ignore it's value */
963 cmd
->cmd
.scan
->fields
[field_count
].num_bits
= 1;
964 cmd
->cmd
.scan
->fields
[field_count
].out_value
= NULL
;
965 cmd
->cmd
.scan
->fields
[field_count
].in_value
= NULL
;
971 void jtag_add_plain_dr_scan(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
977 retval
=interface_jtag_add_plain_dr_scan(in_num_fields
, in_fields
, cmd_queue_end_state
);
978 if (retval
!=ERROR_OK
)
982 int MINIDRIVER(interface_jtag_add_plain_dr_scan
)(int in_num_fields
, scan_field_t
*in_fields
, tap_state_t state
)
984 /* allocate memory for a new list member */
985 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
987 jtag_queue_command(cmd
);
989 cmd
->type
= JTAG_SCAN
;
991 /* allocate memory for scan command */
992 cmd
->cmd
.scan
= cmd_queue_alloc(sizeof(scan_command_t
));
993 cmd
->cmd
.scan
->ir_scan
= false;
994 cmd
->cmd
.scan
->num_fields
= in_num_fields
;
995 cmd
->cmd
.scan
->fields
= cmd_queue_alloc(in_num_fields
* sizeof(scan_field_t
));
996 cmd
->cmd
.scan
->end_state
= state
;
998 for (int i
= 0; i
< in_num_fields
; i
++)
1000 int num_bits
= in_fields
[i
].num_bits
;
1001 int num_bytes
= CEIL(in_fields
[i
].num_bits
, 8);
1002 cmd
->cmd
.scan
->fields
[i
].tap
= in_fields
[i
].tap
;
1003 cmd
->cmd
.scan
->fields
[i
].num_bits
= num_bits
;
1004 cmd
->cmd
.scan
->fields
[i
].out_value
= buf_cpy(in_fields
[i
].out_value
, cmd_queue_alloc(num_bytes
), num_bits
);
1005 cmd
->cmd
.scan
->fields
[i
].in_value
= in_fields
[i
].in_value
;
1011 void jtag_add_tlr(void)
1013 jtag_prelude(TAP_RESET
);
1016 retval
=interface_jtag_add_tlr();
1017 if (retval
!=ERROR_OK
)
1021 int MINIDRIVER(interface_jtag_add_tlr
)(void)
1023 tap_state_t state
= TAP_RESET
;
1025 /* allocate memory for a new list member */
1026 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
1028 jtag_queue_command(cmd
);
1030 cmd
->type
= JTAG_STATEMOVE
;
1032 cmd
->cmd
.statemove
= cmd_queue_alloc(sizeof(statemove_command_t
));
1033 cmd
->cmd
.statemove
->end_state
= state
;
1038 void jtag_add_pathmove(int num_states
, tap_state_t
*path
)
1040 tap_state_t cur_state
= cmd_queue_cur_state
;
1044 /* the last state has to be a stable state */
1045 if (!tap_is_state_stable(path
[num_states
- 1]))
1047 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
1051 for (i
=0; i
<num_states
; i
++)
1053 if (path
[i
] == TAP_RESET
)
1055 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
1059 if ( tap_state_transition(cur_state
, true) != path
[i
]
1060 && tap_state_transition(cur_state
, false) != path
[i
])
1062 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[i
]));
1065 cur_state
= path
[i
];
1070 retval
= interface_jtag_add_pathmove(num_states
, path
);
1071 cmd_queue_cur_state
= path
[num_states
- 1];
1072 if (retval
!=ERROR_OK
)
1076 int MINIDRIVER(interface_jtag_add_pathmove
)(int num_states
, tap_state_t
*path
)
1078 /* allocate memory for a new list member */
1079 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
1081 jtag_queue_command(cmd
);
1083 cmd
->type
= JTAG_PATHMOVE
;
1085 cmd
->cmd
.pathmove
= cmd_queue_alloc(sizeof(pathmove_command_t
));
1086 cmd
->cmd
.pathmove
->num_states
= num_states
;
1087 cmd
->cmd
.pathmove
->path
= cmd_queue_alloc(sizeof(tap_state_t
) * num_states
);
1089 for (int i
= 0; i
< num_states
; i
++)
1090 cmd
->cmd
.pathmove
->path
[i
] = path
[i
];
1095 int MINIDRIVER(interface_jtag_add_runtest
)(int num_cycles
, tap_state_t state
)
1097 /* allocate memory for a new list member */
1098 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
1100 jtag_queue_command(cmd
);
1102 cmd
->type
= JTAG_RUNTEST
;
1104 cmd
->cmd
.runtest
= cmd_queue_alloc(sizeof(runtest_command_t
));
1105 cmd
->cmd
.runtest
->num_cycles
= num_cycles
;
1106 cmd
->cmd
.runtest
->end_state
= state
;
1111 void jtag_add_runtest(int num_cycles
, tap_state_t state
)
1115 jtag_prelude(state
);
1117 /* executed by sw or hw fifo */
1118 retval
=interface_jtag_add_runtest(num_cycles
, cmd_queue_end_state
);
1119 if (retval
!=ERROR_OK
)
1124 int MINIDRIVER(interface_jtag_add_clocks
)( int num_cycles
)
1126 /* allocate memory for a new list member */
1127 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
1129 jtag_queue_command(cmd
);
1131 cmd
->type
= JTAG_STABLECLOCKS
;
1133 cmd
->cmd
.stableclocks
= cmd_queue_alloc(sizeof(stableclocks_command_t
));
1134 cmd
->cmd
.stableclocks
->num_cycles
= num_cycles
;
1139 void jtag_add_clocks( int num_cycles
)
1143 if( !tap_is_state_stable(cmd_queue_cur_state
) )
1145 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
1146 tap_state_name(cmd_queue_cur_state
) );
1147 jtag_error
= ERROR_JTAG_NOT_STABLE_STATE
;
1151 if( num_cycles
> 0 )
1155 retval
= interface_jtag_add_clocks(num_cycles
);
1156 if (retval
!= ERROR_OK
)
1161 void jtag_add_reset(int req_tlr_or_trst
, int req_srst
)
1163 int trst_with_tlr
= 0;
1166 /* FIX!!! there are *many* different cases here. A better
1167 * approach is needed for legal combinations of transitions...
1169 if ((jtag_reset_config
& RESET_HAS_SRST
)&&
1170 (jtag_reset_config
& RESET_HAS_TRST
)&&
1171 ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0))
1173 if (((req_tlr_or_trst
&&!jtag_trst
)||
1174 (!req_tlr_or_trst
&&jtag_trst
))&&
1175 ((req_srst
&&!jtag_srst
)||
1176 (!req_srst
&&jtag_srst
)))
1178 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
1179 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
1183 /* Make sure that jtag_reset_config allows the requested reset */
1184 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
1185 if (((jtag_reset_config
& RESET_SRST_PULLS_TRST
) && (req_srst
== 1)) && (!req_tlr_or_trst
))
1187 LOG_ERROR("BUG: requested reset would assert trst");
1188 jtag_error
=ERROR_FAIL
;
1192 /* if TRST pulls SRST, we reset with TAP T-L-R */
1193 if (((jtag_reset_config
& RESET_TRST_PULLS_SRST
) && (req_tlr_or_trst
)) && (req_srst
== 0))
1198 if (req_srst
&& !(jtag_reset_config
& RESET_HAS_SRST
))
1200 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
1201 jtag_error
=ERROR_FAIL
;
1205 if (req_tlr_or_trst
)
1207 if (!trst_with_tlr
&& (jtag_reset_config
& RESET_HAS_TRST
))
1219 jtag_srst
= req_srst
;
1221 retval
= interface_jtag_add_reset(jtag_trst
, jtag_srst
);
1222 if (retval
!=ERROR_OK
)
1230 LOG_DEBUG("SRST line asserted");
1234 LOG_DEBUG("SRST line released");
1235 if (jtag_nsrst_delay
)
1236 jtag_add_sleep(jtag_nsrst_delay
* 1000);
1241 LOG_DEBUG("JTAG reset with RESET instead of TRST");
1242 jtag_add_end_state(TAP_RESET
);
1244 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
1250 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1251 * and inform possible listeners about this
1253 LOG_DEBUG("TRST line asserted");
1254 cmd_queue_cur_state
= TAP_RESET
;
1255 jtag_call_event_callbacks(JTAG_TRST_ASSERTED
);
1259 if (jtag_ntrst_delay
)
1260 jtag_add_sleep(jtag_ntrst_delay
* 1000);
1264 int MINIDRIVER(interface_jtag_add_reset
)(int req_trst
, int req_srst
)
1266 /* allocate memory for a new list member */
1267 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
1269 jtag_queue_command(cmd
);
1271 cmd
->type
= JTAG_RESET
;
1273 cmd
->cmd
.reset
= cmd_queue_alloc(sizeof(reset_command_t
));
1274 cmd
->cmd
.reset
->trst
= req_trst
;
1275 cmd
->cmd
.reset
->srst
= req_srst
;
1280 void jtag_add_end_state(tap_state_t state
)
1282 cmd_queue_end_state
= state
;
1283 if ((cmd_queue_end_state
== TAP_DRSHIFT
)||(cmd_queue_end_state
== TAP_IRSHIFT
))
1285 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
1289 int MINIDRIVER(interface_jtag_add_sleep
)(u32 us
)
1291 /* allocate memory for a new list member */
1292 jtag_command_t
* cmd
= cmd_queue_alloc(sizeof(jtag_command_t
));
1294 jtag_queue_command(cmd
);
1296 cmd
->type
= JTAG_SLEEP
;
1298 cmd
->cmd
.sleep
= cmd_queue_alloc(sizeof(sleep_command_t
));
1299 cmd
->cmd
.sleep
->us
= us
;
1304 void jtag_add_sleep(u32 us
)
1306 keep_alive(); /* we might be running on a very slow JTAG clk */
1307 int retval
=interface_jtag_add_sleep(us
);
1308 if (retval
!=ERROR_OK
)
1313 int jtag_scan_size(scan_command_t
*cmd
)
1318 /* count bits in scan command */
1319 for (i
= 0; i
< cmd
->num_fields
; i
++)
1321 bit_count
+= cmd
->fields
[i
].num_bits
;
1327 int jtag_build_buffer(scan_command_t
*cmd
, u8
**buffer
)
1332 bit_count
= jtag_scan_size(cmd
);
1333 *buffer
= calloc(1,CEIL(bit_count
, 8));
1337 #ifdef _DEBUG_JTAG_IO_
1338 LOG_DEBUG("%s num_fields: %i", cmd
->ir_scan
? "IRSCAN" : "DRSCAN", cmd
->num_fields
);
1341 for (i
= 0; i
< cmd
->num_fields
; i
++)
1343 if (cmd
->fields
[i
].out_value
)
1345 #ifdef _DEBUG_JTAG_IO_
1346 char* char_buf
= buf_to_str(cmd
->fields
[i
].out_value
, (cmd
->fields
[i
].num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: cmd
->fields
[i
].num_bits
, 16);
1348 buf_set_buf(cmd
->fields
[i
].out_value
, 0, *buffer
, bit_count
, cmd
->fields
[i
].num_bits
);
1349 #ifdef _DEBUG_JTAG_IO_
1350 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i
, cmd
->fields
[i
].num_bits
, char_buf
);
1356 #ifdef _DEBUG_JTAG_IO_
1357 LOG_DEBUG("fields[%i].out_value[%i]: NULL", i
, cmd
->fields
[i
].num_bits
);
1361 bit_count
+= cmd
->fields
[i
].num_bits
;
1364 #ifdef _DEBUG_JTAG_IO_
1365 //LOG_DEBUG("bit_count totalling: %i", bit_count );
1371 int jtag_read_buffer(u8
*buffer
, scan_command_t
*cmd
)
1377 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1380 for (i
= 0; i
< cmd
->num_fields
; i
++)
1382 /* if neither in_value nor in_handler
1383 * are specified we don't have to examine this field
1385 if (cmd
->fields
[i
].in_value
)
1387 int num_bits
= cmd
->fields
[i
].num_bits
;
1388 u8
*captured
= buf_set_buf(buffer
, bit_count
, malloc(CEIL(num_bits
, 8)), 0, num_bits
);
1390 #ifdef _DEBUG_JTAG_IO_
1391 char *char_buf
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
1392 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i
, num_bits
, char_buf
);
1396 if (cmd
->fields
[i
].in_value
)
1398 buf_cpy(captured
, cmd
->fields
[i
].in_value
, num_bits
);
1403 bit_count
+= cmd
->fields
[i
].num_bits
;
1409 static const char *jtag_tap_name(jtag_tap_t
*tap
)
1411 return (tap
== NULL
) ? "(unknown)" : tap
->dotted_name
;
1414 int jtag_check_value_inner(u8
*captured
, u8
*in_check_value
, u8
*in_check_mask
, int num_bits
)
1416 int retval
= ERROR_OK
;
1418 int compare_failed
= 0;
1421 compare_failed
= buf_cmp_mask(captured
, in_check_value
, in_check_mask
, num_bits
);
1423 compare_failed
= buf_cmp(captured
, in_check_value
, num_bits
);
1425 if (compare_failed
){
1426 /* An error handler could have caught the failing check
1427 * only report a problem when there wasn't a handler, or if the handler
1428 * acknowledged the error
1431 LOG_WARNING("TAP %s:",
1432 jtag_tap_name(field->tap));
1436 char *captured_char
= buf_to_str(captured
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
1437 char *in_check_value_char
= buf_to_str(in_check_value
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
1441 char *in_check_mask_char
;
1442 in_check_mask_char
= buf_to_str(in_check_mask
, (num_bits
> DEBUG_JTAG_IOZ
) ? DEBUG_JTAG_IOZ
: num_bits
, 16);
1443 LOG_WARNING("value captured during scan didn't pass the requested check:");
1444 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1445 captured_char
, in_check_value_char
, in_check_mask_char
);
1446 free(in_check_mask_char
);
1450 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
);
1453 free(captured_char
);
1454 free(in_check_value_char
);
1456 retval
= ERROR_JTAG_QUEUE_FAILED
;
1463 void jtag_check_value_mask(scan_field_t
*field
, u8
*value
, u8
*mask
)
1465 assert(field
->in_value
!= NULL
);
1469 /* no checking to do */
1473 jtag_execute_queue_noclear();
1475 int retval
=jtag_check_value_inner(field
->in_value
, value
, mask
, field
->num_bits
);
1476 jtag_set_error(retval
);
1481 enum scan_type
jtag_scan_type(scan_command_t
*cmd
)
1486 for (i
= 0; i
< cmd
->num_fields
; i
++)
1488 if (cmd
->fields
[i
].in_value
)
1490 if (cmd
->fields
[i
].out_value
)
1498 #ifndef HAVE_JTAG_MINIDRIVER_H
1499 /* add callback to end of queue */
1500 void jtag_add_callback4(jtag_callback_t callback
, u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
1502 struct jtag_callback_entry
*entry
=cmd_queue_alloc(sizeof(struct jtag_callback_entry
));
1505 entry
->callback
=callback
;
1511 if (jtag_callback_queue_head
==NULL
)
1513 jtag_callback_queue_head
=entry
;
1514 jtag_callback_queue_tail
=entry
;
1517 jtag_callback_queue_tail
->next
=entry
;
1518 jtag_callback_queue_tail
=entry
;
1523 static int jtag_convert_to_callback4(u8
*in
, jtag_callback_data_t data1
, jtag_callback_data_t data2
, jtag_callback_data_t data3
)
1525 ((jtag_callback1_t
)data1
)(in
);
1529 void jtag_add_callback(jtag_callback1_t callback
, u8
*in
)
1531 jtag_add_callback4(jtag_convert_to_callback4
, in
, (jtag_callback_data_t
)callback
, 0, 0);
1535 #ifndef HAVE_JTAG_MINIDRIVER_H
1537 int interface_jtag_execute_queue(void)
1543 LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
1547 retval
= jtag
->execute_queue();
1549 if (retval
== ERROR_OK
)
1551 struct jtag_callback_entry
*entry
;
1552 for (entry
=jtag_callback_queue_head
; entry
!=NULL
; entry
=entry
->next
)
1554 retval
=entry
->callback(entry
->in
, entry
->data1
, entry
->data2
, entry
->data3
);
1555 if (retval
!=ERROR_OK
)
1562 jtag_callback_queue_head
= NULL
;
1563 jtag_callback_queue_tail
= NULL
;
1565 jtag_command_queue
= NULL
;
1566 last_command_pointer
= &jtag_command_queue
;
1572 void jtag_execute_queue_noclear(void)
1574 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
1575 * E.g. a JTAG over TCP/IP or USB....
1577 jtag_flush_queue_count
++;
1579 int retval
=interface_jtag_execute_queue();
1580 /* we keep the first error */
1581 if ((jtag_error
==ERROR_OK
)&&(retval
!=ERROR_OK
))
1587 int jtag_execute_queue(void)
1590 jtag_execute_queue_noclear();
1592 jtag_error
=ERROR_OK
;
1596 int jtag_reset_callback(enum jtag_event event
, void *priv
)
1598 jtag_tap_t
*tap
= priv
;
1602 if (event
== JTAG_TRST_ASSERTED
)
1604 buf_set_ones(tap
->cur_instr
, tap
->ir_length
);
1611 void jtag_sleep(u32 us
)
1613 alive_sleep(us
/1000);
1616 /* Try to examine chain layout according to IEEE 1149.1 §12
1618 int jtag_examine_chain(void)
1622 u8 idcode_buffer
[JTAG_MAX_CHAIN_SIZE
* 4];
1625 int device_count
= 0;
1626 u8 zero_check
= 0x0;
1627 u8 one_check
= 0xff;
1630 field
.num_bits
= sizeof(idcode_buffer
) * 8;
1631 field
.out_value
= idcode_buffer
;
1633 field
.in_value
= idcode_buffer
;
1638 for (i
= 0; i
< JTAG_MAX_CHAIN_SIZE
; i
++)
1640 buf_set_u32(idcode_buffer
, i
* 32, 32, 0x000000FF);
1643 jtag_add_plain_dr_scan(1, &field
, TAP_RESET
);
1644 jtag_execute_queue();
1646 for (i
= 0; i
< JTAG_MAX_CHAIN_SIZE
* 4; i
++)
1648 zero_check
|= idcode_buffer
[i
];
1649 one_check
&= idcode_buffer
[i
];
1652 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1653 if ((zero_check
== 0x00) || (one_check
== 0xff))
1655 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1656 return ERROR_JTAG_INIT_FAILED
;
1659 /* point at the 1st tap */
1660 tap
= jtag_NextEnabledTap(NULL
);
1662 LOG_ERROR("JTAG: No taps enabled?");
1663 return ERROR_JTAG_INIT_FAILED
;
1666 for (bit_count
= 0; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;)
1668 u32 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1669 if ((idcode
& 1) == 0)
1671 /* LSB must not be 0, this indicates a device in bypass */
1672 LOG_WARNING("Tap/Device does not have IDCODE");
1683 /* some devices, such as AVR will output all 1's instead of TDI
1684 input value at end of chain. */
1685 if ((idcode
== 0x000000FF)||(idcode
== 0xFFFFFFFF))
1688 /* End of chain (invalid manufacturer ID)
1690 * The JTAG examine is the very first thing that happens
1692 * A single JTAG device requires only 64 bits to be read back correctly.
1694 * The code below adds a check that the rest of the data scanned (640 bits)
1695 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1697 * earlier and gives more helpful/explicit error messages.
1699 for (bit_count
+= 32; bit_count
< (JTAG_MAX_CHAIN_SIZE
* 32) - 31;bit_count
+= 32)
1701 idcode
= buf_get_u32(idcode_buffer
, bit_count
, 32);
1702 if (unexpected
||((idcode
!= 0x000000FF)&&(idcode
!= 0xFFFFFFFF)))
1704 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count
, idcode
);
1712 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1713 manufacturer
= EXTRACT_MFG(idcode
);
1714 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1715 part
= EXTRACT_PART(idcode
);
1716 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1717 version
= EXTRACT_VER(idcode
);
1719 LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1720 ((tap
!= NULL
) ? (tap
->dotted_name
) : "(not-named)"),
1721 idcode
, manufacturer
, part
, version
);
1727 tap
->idcode
= idcode
;
1729 if (tap
->expected_ids_cnt
> 0) {
1730 /* Loop over the expected identification codes and test for a match */
1732 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1733 if( tap
->idcode
== tap
->expected_ids
[ii
] ){
1738 /* If none of the expected ids matched, log an error */
1739 if (ii
== tap
->expected_ids_cnt
) {
1740 LOG_ERROR("JTAG tap: %s got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1743 EXTRACT_MFG( tap
->idcode
),
1744 EXTRACT_PART( tap
->idcode
),
1745 EXTRACT_VER( tap
->idcode
) );
1746 for (ii
= 0; ii
< tap
->expected_ids_cnt
; ii
++) {
1747 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1750 tap
->expected_ids_cnt
,
1751 tap
->expected_ids
[ii
],
1752 EXTRACT_MFG( tap
->expected_ids
[ii
] ),
1753 EXTRACT_PART( tap
->expected_ids
[ii
] ),
1754 EXTRACT_VER( tap
->expected_ids
[ii
] ) );
1757 return ERROR_JTAG_INIT_FAILED
;
1759 LOG_INFO("JTAG Tap/device matched");
1763 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1767 tap
= jtag_NextEnabledTap(tap
);
1772 /* see if number of discovered devices matches configuration */
1773 if (device_count
!= jtag_NumEnabledTaps())
1775 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1776 device_count
, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1777 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1778 return ERROR_JTAG_INIT_FAILED
;
1784 int jtag_validate_chain(void)
1787 int total_ir_length
= 0;
1793 total_ir_length
= 0;
1795 tap
= jtag_NextEnabledTap(tap
);
1799 total_ir_length
+= tap
->ir_length
;
1802 total_ir_length
+= 2;
1803 ir_test
= malloc(CEIL(total_ir_length
, 8));
1804 buf_set_ones(ir_test
, total_ir_length
);
1807 field
.num_bits
= total_ir_length
;
1808 field
.out_value
= ir_test
;
1809 field
.in_value
= ir_test
;
1812 jtag_add_plain_ir_scan(1, &field
, TAP_RESET
);
1813 jtag_execute_queue();
1819 tap
= jtag_NextEnabledTap(tap
);
1824 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1827 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1828 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
);
1831 return ERROR_JTAG_INIT_FAILED
;
1833 chain_pos
+= tap
->ir_length
;
1836 val
= buf_get_u32(ir_test
, chain_pos
, 2);
1839 char *cbuf
= buf_to_str(ir_test
, total_ir_length
, 16);
1840 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
);
1843 return ERROR_JTAG_INIT_FAILED
;
1851 enum jtag_tap_cfg_param
{
1855 static Jim_Nvp nvp_config_opts
[] = {
1856 { .name
= "-event", .value
= JCFG_EVENT
},
1858 { .name
= NULL
, .value
= -1 }
1861 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
1867 /* parse config or cget options */
1868 while (goi
->argc
> 0) {
1869 Jim_SetEmptyResult (goi
->interp
);
1871 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
1873 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
1879 if (goi
->argc
== 0) {
1880 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
1884 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
1886 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
1890 if (goi
->isconfigure
) {
1891 if (goi
->argc
!= 1) {
1892 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
1896 if (goi
->argc
!= 0) {
1897 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
1903 jtag_tap_event_action_t
*jteap
;
1905 jteap
= tap
->event_action
;
1906 /* replace existing? */
1908 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
1911 jteap
= jteap
->next
;
1914 if (goi
->isconfigure
) {
1915 if (jteap
== NULL
) {
1917 jteap
= calloc(1, sizeof (*jteap
));
1919 jteap
->event
= n
->value
;
1920 Jim_GetOpt_Obj( goi
, &o
);
1922 Jim_DecrRefCount(interp
, jteap
->body
);
1924 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
1925 Jim_IncrRefCount(jteap
->body
);
1927 /* add to head of event list */
1928 jteap
->next
= tap
->event_action
;
1929 tap
->event_action
= jteap
;
1930 Jim_SetEmptyResult(goi
->interp
);
1933 if (jteap
== NULL
) {
1934 Jim_SetEmptyResult(goi
->interp
);
1936 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
1943 } /* while (goi->argc) */
1948 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
1958 const Jim_Nvp opts
[] = {
1959 #define NTAP_OPT_IRLEN 0
1960 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
1961 #define NTAP_OPT_IRMASK 1
1962 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
1963 #define NTAP_OPT_IRCAPTURE 2
1964 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
1965 #define NTAP_OPT_ENABLED 3
1966 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
1967 #define NTAP_OPT_DISABLED 4
1968 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
1969 #define NTAP_OPT_EXPECTED_ID 5
1970 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
1971 { .name
= NULL
, .value
= -1 },
1974 pTap
= malloc( sizeof(jtag_tap_t
) );
1975 memset( pTap
, 0, sizeof(*pTap
) );
1977 Jim_SetResult_sprintf( goi
->interp
, "no memory");
1981 * we expect CHIP + TAP + OPTIONS
1983 if( goi
->argc
< 3 ){
1984 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
1987 Jim_GetOpt_String( goi
, &cp
, NULL
);
1988 pTap
->chip
= strdup(cp
);
1990 Jim_GetOpt_String( goi
, &cp
, NULL
);
1991 pTap
->tapname
= strdup(cp
);
1993 /* name + dot + name + null */
1994 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
1996 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
1997 pTap
->dotted_name
= cp
;
1999 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
2000 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
2002 /* default is enabled */
2005 /* deal with options */
2006 #define NTREQ_IRLEN 1
2007 #define NTREQ_IRCAPTURE 2
2008 #define NTREQ_IRMASK 4
2010 /* clear them as we find them */
2011 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
2014 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
2016 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
2019 LOG_DEBUG("Processing option: %s", n
->name
);
2021 case NTAP_OPT_ENABLED
:
2024 case NTAP_OPT_DISABLED
:
2027 case NTAP_OPT_EXPECTED_ID
:
2029 u32
*new_expected_ids
;
2031 e
= Jim_GetOpt_Wide( goi
, &w
);
2033 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
2037 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
2038 if (new_expected_ids
== NULL
) {
2039 Jim_SetResult_sprintf( goi
->interp
, "no memory");
2043 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
2045 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
2047 free(pTap
->expected_ids
);
2048 pTap
->expected_ids
= new_expected_ids
;
2049 pTap
->expected_ids_cnt
++;
2052 case NTAP_OPT_IRLEN
:
2053 case NTAP_OPT_IRMASK
:
2054 case NTAP_OPT_IRCAPTURE
:
2055 e
= Jim_GetOpt_Wide( goi
, &w
);
2057 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
2060 if( (w
< 0) || (w
> 0xffff) ){
2062 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
2063 n
->name
, (int)(w
), (int)(w
));
2067 case NTAP_OPT_IRLEN
:
2068 pTap
->ir_length
= w
;
2069 reqbits
&= (~(NTREQ_IRLEN
));
2071 case NTAP_OPT_IRMASK
:
2072 pTap
->ir_capture_mask
= w
;
2073 reqbits
&= (~(NTREQ_IRMASK
));
2075 case NTAP_OPT_IRCAPTURE
:
2076 pTap
->ir_capture_value
= w
;
2077 reqbits
&= (~(NTREQ_IRCAPTURE
));
2080 } /* switch(n->value) */
2081 } /* while( goi->argc ) */
2083 /* Did we get all the options? */
2086 Jim_SetResult_sprintf( goi
->interp
,
2087 "newtap: %s missing required parameters",
2089 /* TODO: Tell user what is missing :-( */
2090 /* no memory leaks pelase */
2091 free(((void *)(pTap
->expected_ids
)));
2092 free(((void *)(pTap
->chip
)));
2093 free(((void *)(pTap
->tapname
)));
2094 free(((void *)(pTap
->dotted_name
)));
2095 free(((void *)(pTap
)));
2099 pTap
->expected
= malloc( pTap
->ir_length
);
2100 pTap
->expected_mask
= malloc( pTap
->ir_length
);
2101 pTap
->cur_instr
= malloc( pTap
->ir_length
);
2103 buf_set_u32( pTap
->expected
,
2106 pTap
->ir_capture_value
);
2107 buf_set_u32( pTap
->expected_mask
,
2110 pTap
->ir_capture_mask
);
2111 buf_set_ones( pTap
->cur_instr
,
2116 jtag_register_event_callback(jtag_reset_callback
, pTap
);
2118 ppTap
= &(jtag_all_taps
);
2119 while( (*ppTap
) != NULL
){
2120 ppTap
= &((*ppTap
)->next_tap
);
2124 static int n_taps
= 0;
2125 pTap
->abs_chain_position
= n_taps
++;
2127 LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
2128 (*ppTap
)->dotted_name
,
2129 (*ppTap
)->abs_chain_position
,
2130 (*ppTap
)->ir_length
,
2131 (*ppTap
)->ir_capture_value
,
2132 (*ppTap
)->ir_capture_mask
);
2137 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
2143 struct command_context_s
*context
;
2147 JTAG_CMD_INIT_RESET
,
2150 JTAG_CMD_TAPDISABLE
,
2151 JTAG_CMD_TAPISENABLED
,
2156 const Jim_Nvp jtag_cmds
[] = {
2157 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
2158 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
2159 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
2160 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
2161 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
2162 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
2163 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
2164 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
2166 { .name
= NULL
, .value
= -1 },
2169 context
= Jim_GetAssocData(interp
, "context");
2170 /* go past the command */
2171 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
2173 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
2175 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
2178 Jim_SetEmptyResult( goi
.interp
);
2180 case JTAG_CMD_INTERFACE
:
2181 /* return the name of the interface */
2182 /* TCL code might need to know the exact type... */
2183 /* FUTURE: we allow this as a means to "set" the interface. */
2184 if( goi
.argc
!= 0 ){
2185 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
2188 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
2190 case JTAG_CMD_INIT_RESET
:
2191 if( goi
.argc
!= 0 ){
2192 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
2195 e
= jtag_init_reset(context
);
2196 if( e
!= ERROR_OK
){
2197 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
2201 case JTAG_CMD_NEWTAP
:
2202 return jim_newtap_cmd( &goi
);
2204 case JTAG_CMD_TAPISENABLED
:
2205 case JTAG_CMD_TAPENABLE
:
2206 case JTAG_CMD_TAPDISABLE
:
2207 if( goi
.argc
!= 1 ){
2208 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
2214 t
= jtag_TapByJimObj( goi
.interp
, goi
.argv
[0] );
2219 case JTAG_CMD_TAPISENABLED
:
2222 case JTAG_CMD_TAPENABLE
:
2223 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
2227 case JTAG_CMD_TAPDISABLE
:
2228 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
2233 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
2240 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
2247 Jim_GetOpt_Obj(&goi
, &o
);
2248 t
= jtag_TapByJimObj( goi
.interp
, o
);
2253 goi
.isconfigure
= 0;
2254 return jtag_tap_configure_cmd( &goi
, t
);
2258 case JTAG_CMD_CONFIGURE
:
2260 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
2267 Jim_GetOpt_Obj(&goi
, &o
);
2268 t
= jtag_TapByJimObj( goi
.interp
, o
);
2273 goi
.isconfigure
= 1;
2274 return jtag_tap_configure_cmd( &goi
, t
);
2281 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
2283 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
2285 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
2286 COMMAND_CONFIG
, "try to configure interface");
2287 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
2288 COMMAND_ANY
, "set jtag speed (if supported)");
2289 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
2290 COMMAND_ANY
, "same as jtag_speed, except it takes maximum khz as arguments. 0 KHz = RTCK.");
2291 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
2292 COMMAND_CONFIG
, "jtag_device <ir_length> <ir_expected> <ir_mask>");
2293 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
2295 "[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]");
2296 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
2297 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
2298 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
2299 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
2301 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
2302 COMMAND_EXEC
, "print current scan chain configuration");
2304 register_command(cmd_ctx
, NULL
, "endstate", handle_endstate_command
,
2305 COMMAND_EXEC
, "finish JTAG operations in <tap_state>");
2306 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
2307 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
2308 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
2309 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
2310 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
2311 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
2312 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
2313 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
2315 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
2316 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
2317 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
2318 COMMAND_ANY
, "verify value capture <enable|disable>");
2319 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
2320 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
2324 int jtag_interface_init(struct command_context_s
*cmd_ctx
)
2329 if (!jtag_interface
)
2331 /* nothing was previously specified by "interface" command */
2332 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
2333 return ERROR_JTAG_INVALID_INTERFACE
;
2337 jtag_interface
->khz(speed_khz
, &jtag_speed
);
2341 if (jtag_interface
->init() != ERROR_OK
)
2342 return ERROR_JTAG_INIT_FAILED
;
2344 jtag
= jtag_interface
;
2348 static int jtag_init_inner(struct command_context_s
*cmd_ctx
)
2353 LOG_DEBUG("Init JTAG chain");
2355 tap
= jtag_NextEnabledTap(NULL
);
2357 LOG_ERROR("There are no enabled taps?");
2358 return ERROR_JTAG_INIT_FAILED
;
2362 if ((retval
=jtag_execute_queue())!=ERROR_OK
)
2365 /* examine chain first, as this could discover the real chain layout */
2366 if (jtag_examine_chain() != ERROR_OK
)
2368 LOG_ERROR("trying to validate configured JTAG chain anyway...");
2371 if (jtag_validate_chain() != ERROR_OK
)
2373 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
2379 int jtag_init_reset(struct command_context_s
*cmd_ctx
)
2383 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
2386 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
2388 /* Reset can happen after a power cycle.
2390 * Ideally we would only assert TRST or run RESET before the target reset.
2392 * However w/srst_pulls_trst, trst is asserted together with the target
2393 * reset whether we want it or not.
2395 * NB! Some targets have JTAG circuitry disabled until a
2396 * trst & srst has been asserted.
2398 * NB! here we assume nsrst/ntrst delay are sufficient!
2400 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
2403 jtag_add_reset(1, 0); /* RESET or TRST */
2404 if (jtag_reset_config
& RESET_HAS_SRST
)
2406 jtag_add_reset(1, 1);
2407 if ((jtag_reset_config
& RESET_SRST_PULLS_TRST
)==0)
2408 jtag_add_reset(0, 1);
2410 jtag_add_reset(0, 0);
2411 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
2414 /* Check that we can communication on the JTAG chain + eventually we want to
2415 * be able to perform enumeration only after OpenOCD has started
2416 * telnet and GDB server
2418 * That would allow users to more easily perform any magic they need to before
2421 return jtag_init_inner(cmd_ctx
);
2424 int jtag_init(struct command_context_s
*cmd_ctx
)
2427 if ((retval
=jtag_interface_init(cmd_ctx
)) != ERROR_OK
)
2429 if (jtag_init_inner(cmd_ctx
)==ERROR_OK
)
2433 return jtag_init_reset(cmd_ctx
);
2436 static int default_khz(int khz
, int *jtag_speed
)
2438 LOG_ERROR("Translation from khz to jtag_speed not implemented");
2442 static int default_speed_div(int speed
, int *khz
)
2444 LOG_ERROR("Translation from jtag_speed to khz not implemented");
2448 static int default_power_dropout(int *dropout
)
2450 *dropout
=0; /* by default we can't detect power dropout */
2454 static int default_srst_asserted(int *srst_asserted
)
2456 *srst_asserted
=0; /* by default we can't detect srst asserted */
2460 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2465 /* check whether the interface is already configured */
2468 LOG_WARNING("Interface already configured, ignoring");
2472 /* interface name is a mandatory argument */
2473 if (argc
< 1 || args
[0][0] == '\0')
2475 return ERROR_COMMAND_SYNTAX_ERROR
;
2478 for (i
=0; jtag_interfaces
[i
]; i
++)
2480 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) == 0)
2482 if ((retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
)) != ERROR_OK
)
2487 jtag_interface
= jtag_interfaces
[i
];
2489 if (jtag_interface
->khz
== NULL
)
2491 jtag_interface
->khz
= default_khz
;
2493 if (jtag_interface
->speed_div
== NULL
)
2495 jtag_interface
->speed_div
= default_speed_div
;
2497 if (jtag_interface
->power_dropout
== NULL
)
2499 jtag_interface
->power_dropout
= default_power_dropout
;
2501 if (jtag_interface
->srst_asserted
== NULL
)
2503 jtag_interface
->srst_asserted
= default_srst_asserted
;
2510 /* no valid interface was found (i.e. the configuration option,
2511 * didn't match one of the compiled-in interfaces
2513 LOG_ERROR("No valid jtag interface found (%s)", args
[0]);
2514 LOG_ERROR("compiled-in jtag interfaces:");
2515 for (i
= 0; jtag_interfaces
[i
]; i
++)
2517 LOG_ERROR("%i: %s", i
, jtag_interfaces
[i
]->name
);
2520 return ERROR_JTAG_INVALID_INTERFACE
;
2523 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2527 Jim_Obj
*newargs
[ 10 ];
2530 * argv[-1] = command
2531 * argv[ 0] = ir length
2532 * argv[ 1] = ir capture
2533 * argv[ 2] = ir mask
2534 * argv[ 3] = not actually used by anything but in the docs
2538 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2541 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2542 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2546 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2547 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2548 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2549 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
2551 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
2552 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
2553 sprintf( buf
, "chip%d", jtag_NumTotalTaps() );
2554 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
2555 sprintf( buf
, "tap%d", jtag_NumTotalTaps() );
2556 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
2557 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
2558 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
2559 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
2560 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
2561 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
2562 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
2564 command_print( cmd_ctx
, "NEW COMMAND:");
2565 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
2566 Jim_GetString( newargs
[0], NULL
),
2567 Jim_GetString( newargs
[1], NULL
),
2568 Jim_GetString( newargs
[2], NULL
),
2569 Jim_GetString( newargs
[3], NULL
),
2570 Jim_GetString( newargs
[4], NULL
),
2571 Jim_GetString( newargs
[5], NULL
),
2572 Jim_GetString( newargs
[6], NULL
),
2573 Jim_GetString( newargs
[7], NULL
),
2574 Jim_GetString( newargs
[8], NULL
),
2575 Jim_GetString( newargs
[9], NULL
) );
2577 e
= jim_jtag_command( interp
, 10, newargs
);
2579 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
2584 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2588 tap
= jtag_all_taps
;
2589 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
2590 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
2593 u32 expected
, expected_mask
, cur_instr
, ii
;
2594 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
2595 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
2596 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
2598 command_print(cmd_ctx
,
2599 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2600 tap
->abs_chain_position
,
2602 tap
->enabled
? 'Y' : 'n',
2604 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
2610 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
2611 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
2612 tap
->expected_ids
[ii
]);
2615 tap
= tap
->next_tap
;
2621 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2624 return ERROR_COMMAND_SYNTAX_ERROR
;
2628 if (strcmp(args
[0], "none") == 0)
2629 jtag_reset_config
= RESET_NONE
;
2630 else if (strcmp(args
[0], "trst_only") == 0)
2631 jtag_reset_config
= RESET_HAS_TRST
;
2632 else if (strcmp(args
[0], "srst_only") == 0)
2633 jtag_reset_config
= RESET_HAS_SRST
;
2634 else if (strcmp(args
[0], "trst_and_srst") == 0)
2635 jtag_reset_config
= RESET_TRST_AND_SRST
;
2638 LOG_ERROR("(1) invalid reset_config argument (%s), defaulting to none", args
[0]);
2639 jtag_reset_config
= RESET_NONE
;
2640 return ERROR_INVALID_ARGUMENTS
;
2646 if (strcmp(args
[1], "separate") == 0)
2648 /* seperate reset lines - default */
2651 if (strcmp(args
[1], "srst_pulls_trst") == 0)
2652 jtag_reset_config
|= RESET_SRST_PULLS_TRST
;
2653 else if (strcmp(args
[1], "trst_pulls_srst") == 0)
2654 jtag_reset_config
|= RESET_TRST_PULLS_SRST
;
2655 else if (strcmp(args
[1], "combined") == 0)
2656 jtag_reset_config
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
2659 LOG_ERROR("(2) invalid reset_config argument (%s), defaulting to none", args
[1]);
2660 jtag_reset_config
= RESET_NONE
;
2661 return ERROR_INVALID_ARGUMENTS
;
2668 if (strcmp(args
[2], "trst_open_drain") == 0)
2669 jtag_reset_config
|= RESET_TRST_OPEN_DRAIN
;
2670 else if (strcmp(args
[2], "trst_push_pull") == 0)
2671 jtag_reset_config
&= ~RESET_TRST_OPEN_DRAIN
;
2674 LOG_ERROR("(3) invalid reset_config argument (%s) defaulting to none", args
[2] );
2675 jtag_reset_config
= RESET_NONE
;
2676 return ERROR_INVALID_ARGUMENTS
;
2682 if (strcmp(args
[3], "srst_push_pull") == 0)
2683 jtag_reset_config
|= RESET_SRST_PUSH_PULL
;
2684 else if (strcmp(args
[3], "srst_open_drain") == 0)
2685 jtag_reset_config
&= ~RESET_SRST_PUSH_PULL
;
2688 LOG_ERROR("(4) invalid reset_config argument (%s), defaulting to none", args
[3]);
2689 jtag_reset_config
= RESET_NONE
;
2690 return ERROR_INVALID_ARGUMENTS
;
2697 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2701 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2706 jtag_nsrst_delay
= strtoul(args
[0], NULL
, 0);
2712 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2716 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2721 jtag_ntrst_delay
= strtoul(args
[0], NULL
, 0);
2727 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2729 int retval
=ERROR_OK
;
2733 LOG_DEBUG("handle jtag speed");
2736 cur_speed
= jtag_speed
= strtoul(args
[0], NULL
, 0);
2738 /* this command can be called during CONFIG,
2739 * in which case jtag isn't initialized */
2742 retval
=jtag
->speed(cur_speed
);
2744 } else if (argc
== 0)
2748 return ERROR_COMMAND_SYNTAX_ERROR
;
2750 command_print(cmd_ctx
, "jtag_speed: %d", jtag_speed
);
2755 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2757 int retval
=ERROR_OK
;
2758 LOG_DEBUG("handle jtag khz");
2762 speed_khz
= strtoul(args
[0], NULL
, 0);
2766 LOG_DEBUG("have interface set up");
2768 if ((retval
=jtag
->khz(speed_khz
, &speed_div1
))!=ERROR_OK
)
2774 cur_speed
= jtag_speed
= speed_div1
;
2776 retval
=jtag
->speed(cur_speed
);
2785 return ERROR_COMMAND_SYNTAX_ERROR
;
2790 if ((retval
=jtag
->speed_div(jtag_speed
, &speed_khz
))!=ERROR_OK
)
2796 command_print(cmd_ctx
, "RCLK - adaptive");
2799 command_print(cmd_ctx
, "%d kHz", speed_khz
);
2805 static int handle_endstate_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2811 return ERROR_COMMAND_SYNTAX_ERROR
;
2815 state
= tap_state_by_name( args
[0] );
2817 command_print( cmd_ctx
, "Invalid state name: %s\n", args
[0] );
2818 return ERROR_COMMAND_SYNTAX_ERROR
;
2820 jtag_add_end_state(state
);
2821 jtag_execute_queue();
2823 command_print(cmd_ctx
, "current endstate: %s", tap_state_name(cmd_queue_end_state
));
2828 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2835 return ERROR_COMMAND_SYNTAX_ERROR
;
2838 if (args
[0][0] == '1')
2840 else if (args
[0][0] == '0')
2844 return ERROR_COMMAND_SYNTAX_ERROR
;
2847 if (args
[1][0] == '1')
2849 else if (args
[1][0] == '0')
2853 return ERROR_COMMAND_SYNTAX_ERROR
;
2856 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
2857 return ERROR_JTAG_INIT_FAILED
;
2859 jtag_add_reset(trst
, srst
);
2860 jtag_execute_queue();
2865 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2869 return ERROR_COMMAND_SYNTAX_ERROR
;
2872 jtag_add_runtest(strtol(args
[0], NULL
, 0), TAP_INVALID
);
2873 jtag_execute_queue();
2879 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
2882 scan_field_t
*fields
;
2884 tap_state_t endstate
;
2886 if ((argc
< 2) || (argc
% 2))
2888 return ERROR_COMMAND_SYNTAX_ERROR
;
2891 /* optional "-endstate" */
2893 /* at the end of the arguments. */
2895 endstate
= cmd_queue_end_state
;
2897 /* have at least one pair of numbers. */
2898 /* is last pair the magic text? */
2899 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
2902 cpA
= args
[ argc
-1 ];
2903 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
2904 cpS
= tap_state_name( endstate
);
2905 if( 0 == strcmp( cpA
, cpS
) ){
2909 if( endstate
>= TAP_NUM_STATES
){
2910 return ERROR_COMMAND_SYNTAX_ERROR
;
2912 /* found - remove the last 2 args */
2918 int num_fields
= argc
/ 2;
2920 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
2922 for (i
= 0; i
< num_fields
; i
++)
2924 tap
= jtag_TapByString( args
[i
*2] );
2927 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
2930 int field_size
= tap
->ir_length
;
2931 fields
[i
].tap
= tap
;
2932 fields
[i
].num_bits
= field_size
;
2933 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
2934 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
2935 fields
[i
].in_value
= NULL
;
2938 /* did we have an endstate? */
2939 jtag_add_ir_scan(num_fields
, fields
, endstate
);
2941 int retval
=jtag_execute_queue();
2943 for (i
= 0; i
< num_fields
; i
++)
2944 free(fields
[i
].out_value
);
2951 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
2954 scan_field_t
*fields
;
2956 int field_count
= 0;
2959 tap_state_t endstate
;
2962 * args[2] = num_bits
2963 * args[3] = hex string
2964 * ... repeat num bits and hex string ...
2967 * args[N-2] = "-endstate"
2968 * args[N-1] = statename
2970 if ((argc
< 4) || ((argc
% 2)!=0))
2972 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
2976 /* assume no endstate */
2977 endstate
= cmd_queue_end_state
;
2978 /* validate arguments as numbers */
2980 for (i
= 2; i
< argc
; i
+=2)
2985 e
= Jim_GetLong(interp
, args
[i
], &bits
);
2986 /* If valid - try next arg */
2991 /* Not valid.. are we at the end? */
2992 if ( ((i
+2) != argc
) ){
2993 /* nope, then error */
2997 /* it could be: "-endstate FOO" */
2999 /* get arg as a string. */
3000 cp
= Jim_GetString( args
[i
], NULL
);
3001 /* is it the magic? */
3002 if( 0 == strcmp( "-endstate", cp
) ){
3003 /* is the statename valid? */
3004 cp
= Jim_GetString( args
[i
+1], NULL
);
3006 /* see if it is a valid state name */
3007 endstate
= tap_state_by_name(cp
);
3009 /* update the error message */
3010 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
3012 /* valid - so clear the error */
3014 /* and remove the last 2 args */
3019 /* Still an error? */
3021 return e
; /* too bad */
3023 } /* validate args */
3025 tap
= jtag_TapByJimObj( interp
, args
[1] );
3030 num_fields
=(argc
-2)/2;
3031 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
3032 for (i
= 2; i
< argc
; i
+=2)
3038 Jim_GetLong(interp
, args
[i
], &bits
);
3039 str
= Jim_GetString(args
[i
+1], &len
);
3041 fields
[field_count
].tap
= tap
;
3042 fields
[field_count
].num_bits
= bits
;
3043 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
3044 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
3045 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
3049 jtag_add_dr_scan(num_fields
, fields
, endstate
);
3051 retval
= jtag_execute_queue();
3052 if (retval
!= ERROR_OK
)
3054 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
3059 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
3060 for (i
= 2; i
< argc
; i
+=2)
3065 Jim_GetLong(interp
, args
[i
], &bits
);
3066 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
3067 free(fields
[field_count
].out_value
);
3069 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
3074 Jim_SetResult(interp
, list
);
3082 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
3084 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_flush_queue_count
));
3090 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
3094 if (strcmp(args
[0], "enable") == 0)
3096 jtag_verify_capture_ir
= 1;
3098 else if (strcmp(args
[0], "disable") == 0)
3100 jtag_verify_capture_ir
= 0;
3103 return ERROR_COMMAND_SYNTAX_ERROR
;
3105 } else if (argc
!= 0)
3107 return ERROR_COMMAND_SYNTAX_ERROR
;
3110 command_print(cmd_ctx
, "verify Capture-IR is %s", (jtag_verify_capture_ir
) ? "enabled": "disabled");
3115 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
3119 if (strcmp(args
[0], "enable") == 0)
3123 else if (strcmp(args
[0], "disable") == 0)
3128 return ERROR_COMMAND_SYNTAX_ERROR
;
3130 } else if (argc
!= 0)
3132 return ERROR_COMMAND_SYNTAX_ERROR
;
3135 command_print(cmd_ctx
, "verify jtag capture is %s", (jtag_verify
) ? "enabled": "disabled");
3141 int jtag_power_dropout(int *dropout
)
3143 return jtag
->power_dropout(dropout
);
3146 int jtag_srst_asserted(int *srst_asserted
)
3148 return jtag
->srst_asserted(srst_asserted
);
3151 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
3153 jtag_tap_event_action_t
* jteap
;
3156 jteap
= tap
->event_action
;
3160 if (jteap
->event
== e
) {
3162 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
3165 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
3166 Jim_GetString(jteap
->body
, NULL
) );
3167 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
3168 Jim_PrintErrorMessage(interp
);
3172 jteap
= jteap
->next
;
3176 LOG_DEBUG( "event %d %s - no action",
3178 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
3182 /*-----<Cable Helper API>---------------------------------------*/
3184 /* these Cable Helper API functions are all documented in the jtag.h header file,
3185 using a Doxygen format. And since Doxygen's configuration file "Doxyfile",
3186 is setup to prefer its docs in the header file, no documentation is here, for
3187 if it were, it would have to be doubly maintained.
3191 * @see tap_set_state() and tap_get_state() accessors.
3192 * Actual name is not important since accessors hide it.
3194 static tap_state_t state_follower
= TAP_RESET
;
3196 void tap_set_state_impl( tap_state_t new_state
)
3198 /* this is the state we think the TAPs are in now, was cur_state */
3199 state_follower
= new_state
;
3202 tap_state_t
tap_get_state()
3204 return state_follower
;
3208 * @see tap_set_end_state() and tap_get_end_state() accessors.
3209 * Actual name is not important because accessors hide it.
3211 static tap_state_t end_state_follower
= TAP_RESET
;
3213 void tap_set_end_state( tap_state_t new_end_state
)
3215 /* this is the state we think the TAPs will be in at completion of the
3216 current TAP operation, was end_state
3218 end_state_follower
= new_end_state
;
3221 tap_state_t
tap_get_end_state()
3223 return end_state_follower
;
3227 int tap_move_ndx( tap_state_t astate
)
3229 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
3235 case TAP_RESET
: ndx
= 0; break;
3236 case TAP_DRSHIFT
: ndx
= 2; break;
3237 case TAP_DRPAUSE
: ndx
= 3; break;
3238 case TAP_IDLE
: ndx
= 1; break;
3239 case TAP_IRSHIFT
: ndx
= 4; break;
3240 case TAP_IRPAUSE
: ndx
= 5; break;
3242 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate
) );
3250 /* tap_move[i][j]: tap movement command to go from state i to state j
3251 * 0: Test-Logic-Reset
3258 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
3260 struct tms_sequences
3268 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
3269 * Read the bits from LSBit first to MSBit last (right-to-left).
3271 #define HEX__(n) 0x##n##LU
3274 (((x) & 0x0000000FLU)?(1<<0):0) \
3275 +(((x) & 0x000000F0LU)?(1<<1):0) \
3276 +(((x) & 0x00000F00LU)?(1<<2):0) \
3277 +(((x) & 0x0000F000LU)?(1<<3):0) \
3278 +(((x) & 0x000F0000LU)?(1<<4):0) \
3279 +(((x) & 0x00F00000LU)?(1<<5):0) \
3280 +(((x) & 0x0F000000LU)?(1<<6):0) \
3281 +(((x) & 0xF0000000LU)?(1<<7):0)
3283 #define B8(bits,count) { ((u8)B8__(HEX__(bits))), (count) }
3285 static const struct tms_sequences old_tms_seqs
[6][6] = /* [from_state_ndx][to_state_ndx] */
3287 /* value clocked to TMS to move from one of six stable states to another.
3288 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
3289 * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
3290 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
3291 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
3297 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3298 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3299 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
3300 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
3301 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
3302 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
3303 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* IRPAUSE */
3308 static const struct tms_sequences short_tms_seqs
[6][6] = /* [from_state_ndx][to_state_ndx] */
3310 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
3312 OK, I added Peter's version of the state table, and it works OK for
3313 me on MC1322x. I've recreated the jlink portion of patch with this
3314 new state table. His changes to my state table are pretty minor in
3315 terms of total transitions, but Peter feels that his version fixes
3316 some long-standing problems.
3319 I added the bit count into the table, reduced RESET column to 7 bits from 8.
3322 state specific comments:
3323 ------------------------
3324 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
3325 work better on ARM9 with ft2232 driver. (Dick)
3327 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3328 needed on ARM9 with ft2232 driver. (Dick)
3330 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3331 needed on ARM9 with ft2232 driver. (Dick)
3335 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3336 { B8(1111111,7), B8(0000000,7), B8(00101,5), B8(01010,5), B8(001101,6), B8(010110,6) }, /* RESET */
3337 { B8(1111111,7), B8(0000000,7), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
3338 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
3339 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
3340 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
3341 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
3345 typedef const struct tms_sequences tms_table
[6][6];
3347 static tms_table
*tms_seqs
=&short_tms_seqs
;
3349 int tap_get_tms_path( tap_state_t from
, tap_state_t to
)
3351 return (*tms_seqs
)[tap_move_ndx(from
)][tap_move_ndx(to
)].bits
;
3355 int tap_get_tms_path_len( tap_state_t from
, tap_state_t to
)
3357 return (*tms_seqs
)[tap_move_ndx(from
)][tap_move_ndx(to
)].bit_count
;
3361 bool tap_is_state_stable(tap_state_t astate
)
3365 /* A switch() is used because it is symbol dependent
3366 (not value dependent like an array), and can also check bounds.
3385 tap_state_t
tap_state_transition(tap_state_t cur_state
, bool tms
)
3387 tap_state_t new_state
;
3389 /* A switch is used because it is symbol dependent and not value dependent
3390 like an array. Also it can check for out of range conditions.
3398 new_state
= cur_state
;
3403 new_state
= TAP_DRSELECT
;
3406 new_state
= TAP_IRSELECT
;
3410 new_state
= TAP_DREXIT1
;
3414 new_state
= TAP_DRUPDATE
;
3417 new_state
= TAP_DREXIT2
;
3420 new_state
= TAP_RESET
;
3424 new_state
= TAP_IREXIT1
;
3428 new_state
= TAP_IRUPDATE
;
3431 new_state
= TAP_IREXIT2
;
3434 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state
);
3447 new_state
= TAP_IDLE
;
3450 new_state
= TAP_DRCAPTURE
;
3455 new_state
= TAP_DRSHIFT
;
3459 new_state
= TAP_DRPAUSE
;
3462 new_state
= TAP_IRCAPTURE
;
3467 new_state
= TAP_IRSHIFT
;
3471 new_state
= TAP_IRPAUSE
;
3474 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state
);
3483 const char* tap_state_name(tap_state_t state
)
3489 case TAP_RESET
: ret
= "RESET"; break;
3490 case TAP_IDLE
: ret
= "RUN/IDLE"; break;
3491 case TAP_DRSELECT
: ret
= "DRSELECT"; break;
3492 case TAP_DRCAPTURE
: ret
= "DRCAPTURE"; break;
3493 case TAP_DRSHIFT
: ret
= "DRSHIFT"; break;
3494 case TAP_DREXIT1
: ret
= "DREXIT1"; break;
3495 case TAP_DRPAUSE
: ret
= "DRPAUSE"; break;
3496 case TAP_DREXIT2
: ret
= "DREXIT2"; break;
3497 case TAP_DRUPDATE
: ret
= "DRUPDATE"; break;
3498 case TAP_IRSELECT
: ret
= "IRSELECT"; break;
3499 case TAP_IRCAPTURE
: ret
= "IRCAPTURE"; break;
3500 case TAP_IRSHIFT
: ret
= "IRSHIFT"; break;
3501 case TAP_IREXIT1
: ret
= "IREXIT1"; break;
3502 case TAP_IRPAUSE
: ret
= "IRPAUSE"; break;
3503 case TAP_IREXIT2
: ret
= "IREXIT2"; break;
3504 case TAP_IRUPDATE
: ret
= "IRUPDATE"; break;
3505 default: ret
= "???";
3511 static tap_state_t
tap_state_by_name( const char *name
)
3515 for( x
= 0 ; x
< TAP_NUM_STATES
; x
++ ){
3516 /* be nice to the human */
3517 if( 0 == strcasecmp( name
, tap_state_name(x
) ) ){
3525 #ifdef _DEBUG_JTAG_IO_
3527 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3528 do { buf[len] = bit ? '1' : '0'; } while(0)
3529 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3530 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3531 tap_state_name(a), tap_state_name(b), astr, bstr)
3533 tap_state_t
jtag_debug_state_machine(const void *tms_buf
, const void *tdi_buf
,
3534 unsigned tap_bits
, tap_state_t next_state
)
3536 const u8
*tms_buffer
;
3537 const u8
*tdi_buffer
;
3542 unsigned tap_out_bits
;
3546 tap_state_t last_state
;
3548 // set startstate (and possibly last, if tap_bits == 0)
3549 last_state
= next_state
;
3550 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state
));
3552 tms_buffer
= (const u8
*)tms_buf
;
3553 tdi_buffer
= (const u8
*)tdi_buf
;
3555 tap_bytes
= TAP_SCAN_BYTES(tap_bits
);
3556 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits
, tap_bytes
);
3559 for(cur_byte
= 0; cur_byte
< tap_bytes
; cur_byte
++)
3561 for(cur_bit
= 0; cur_bit
< 8; cur_bit
++)
3563 // make sure we do not run off the end of the buffers
3564 unsigned tap_bit
= cur_byte
* 8 + cur_bit
;
3565 if (tap_bit
== tap_bits
)
3568 // check and save TMS bit
3569 tap_bit
= !!(tms_buffer
[cur_byte
] & (1 << cur_bit
));
3570 JTAG_DEBUG_STATE_APPEND(tms_str
, tap_out_bits
, tap_bit
);
3572 // use TMS bit to find the next TAP state
3573 next_state
= tap_state_transition(last_state
, tap_bit
);
3575 // check and store TDI bit
3576 tap_bit
= !!(tdi_buffer
[cur_byte
] & (1 << cur_bit
));
3577 JTAG_DEBUG_STATE_APPEND(tdi_str
, tap_out_bits
, tap_bit
);
3579 // increment TAP bits
3582 // Only show TDO bits on state transitions, or
3583 // after some number of bits in the same state.
3584 if ((next_state
== last_state
) && (tap_out_bits
< 32))
3587 // terminate strings and display state transition
3588 tms_str
[tap_out_bits
] = tdi_str
[tap_out_bits
] = 0;
3589 JTAG_DEBUG_STATE_PRINT(last_state
, next_state
, tms_str
, tdi_str
);
3592 last_state
= next_state
;
3599 // terminate strings and display state transition
3600 tms_str
[tap_out_bits
] = tdi_str
[tap_out_bits
] = 0;
3601 JTAG_DEBUG_STATE_PRINT(last_state
, next_state
, tms_str
, tdi_str
);
3604 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state
));
3608 #endif // _DEBUG_JTAG_IO_
3610 #ifndef HAVE_JTAG_MINIDRIVER_H
3611 void jtag_alloc_in_value32(scan_field_t
*field
)
3613 field
->in_value
=(u8
*)cmd_queue_alloc(4);
3617 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
3621 if (strcmp(args
[0], "short") == 0)
3623 tms_seqs
=&short_tms_seqs
;
3625 else if (strcmp(args
[0], "long") == 0)
3627 tms_seqs
=&old_tms_seqs
;
3630 return ERROR_COMMAND_SYNTAX_ERROR
;
3632 } else if (argc
!= 0)
3634 return ERROR_COMMAND_SYNTAX_ERROR
;
3637 command_print(cmd_ctx
, "tms sequence is %s", (tms_seqs
==&short_tms_seqs
) ? "short": "long");
3642 /*-----</Cable Helper API>--------------------------------------*/