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 num_fields, scan_field_t *fields, tap_state_t state),
41 int num_fields, scan_field_t *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);
265 jtag_tap_t *jtag_AllTaps(void)
267 return jtag_all_taps;
270 int jtag_NumTotalTaps(void)
284 int jtag_NumEnabledTaps(void)
300 jtag_tap_t *jtag_TapByString( const char *s )
308 if( 0 == strcmp( t->dotted_name, s ) ){
314 /* backup plan is by number */
316 /* ok - is "s" a number? */
318 n = strtol( s, &cp, 0 );
319 if( (s != cp) && (*cp == 0) ){
321 t = jtag_TapByAbsPosition(n);
327 jtag_tap_t * jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *o )
332 cp = Jim_GetString( o, NULL );
337 t = jtag_TapByString( cp );
340 Jim_SetResult_sprintf(interp,"Tap: %s is unknown", cp );
345 /* returns a pointer to the n-th device in the scan chain */
346 jtag_tap_t * jtag_TapByAbsPosition( int n )
354 while( t && (n > 0)) {
361 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
363 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
365 if (callback == NULL)
367 return ERROR_INVALID_ARGUMENTS;
372 while ((*callbacks_p)->next)
373 callbacks_p = &((*callbacks_p)->next);
374 callbacks_p = &((*callbacks_p)->next);
377 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
378 (*callbacks_p)->callback = callback;
379 (*callbacks_p)->priv = priv;
380 (*callbacks_p)->next = NULL;
385 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
387 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
389 if (callback == NULL)
391 return ERROR_INVALID_ARGUMENTS;
396 jtag_event_callback_t **next = &((*callbacks_p)->next);
397 if ((*callbacks_p)->callback == callback)
400 *callbacks_p = *next;
408 int jtag_call_event_callbacks(enum jtag_event event)
410 jtag_event_callback_t *callback = jtag_event_callbacks;
412 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
416 callback->callback(event, callback->priv);
417 callback = callback->next;
423 /* returns a pointer to the pointer of the last command in queue
424 * this may be a pointer to the root pointer (jtag_command_queue)
425 * or to the next member of the last but one command
427 jtag_command_t** jtag_get_last_command_p(void)
429 /* jtag_command_t *cmd = jtag_command_queue;
435 return &jtag_command_queue;
439 return last_command_pointer;
443 void jtag_queue_command(jtag_command_t * cmd)
445 jtag_command_t **last_cmd;
447 last_cmd = jtag_get_last_command_p();
451 (*last_cmd)->next = NULL;
453 last_command_pointer = &((*last_cmd)->next);
457 void* cmd_queue_alloc(size_t size)
459 cmd_queue_page_t **p_page = &cmd_queue_pages;
465 * We align/round the *SIZE* per below
466 * so that all pointers returned by
467 * this function are reasonably well
470 * If we did not, then an "odd-length" request would cause the
471 * *next* allocation to be at an *odd* address, and because
472 * this function has the same type of api as malloc() - we
473 * must also return pointers that have the same type of
476 * What I do not/have is a reasonable portable means
479 * The solution here, is based on these suggestions.
480 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
483 union worse_case_align {
489 #define ALIGN_SIZE (sizeof(union worse_case_align))
491 /* The alignment process. */
492 size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
497 while ((*p_page)->next)
498 p_page = &((*p_page)->next);
499 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
500 p_page = &((*p_page)->next);
505 *p_page = malloc(sizeof(cmd_queue_page_t));
507 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
508 (*p_page)->next = NULL;
511 offset = (*p_page)->used;
512 (*p_page)->used += size;
514 t=(u8 *)((*p_page)->address);
518 void cmd_queue_free(void)
520 cmd_queue_page_t *page = cmd_queue_pages;
524 cmd_queue_page_t *last = page;
530 cmd_queue_pages = NULL;
533 static void jtag_prelude1(void)
537 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
538 jtag_error=ERROR_JTAG_TRST_ASSERTED;
542 if (cmd_queue_end_state == TAP_RESET)
543 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
546 static void jtag_prelude(tap_state_t state)
550 if (state != TAP_INVALID)
551 jtag_add_end_state(state);
553 cmd_queue_cur_state = cmd_queue_end_state;
556 void jtag_add_ir_scan_noverify(int num_fields, scan_field_t *fields, tap_state_t state)
561 retval=interface_jtag_add_ir_scan(num_fields, fields, cmd_queue_end_state);
562 if (retval!=ERROR_OK)
568 void jtag_add_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
570 if (jtag_verify&&jtag_verify_capture_ir)
572 /* 8 x 32 bit id's is enough for all invoations */
574 for (j = 0; j < num_fields; j++)
576 fields[j].check_value=NULL;
577 fields[j].check_mask=NULL;
578 /* if we are to run a verification of the ir scan, we need to get the input back.
579 * We may have to allocate space if the caller didn't ask for the input back.
581 fields[j].check_value=fields[j].tap->expected;
582 fields[j].check_mask=fields[j].tap->expected_mask;
584 jtag_add_scan_check(jtag_add_ir_scan_noverify, num_fields, fields, state);
587 jtag_add_ir_scan_noverify(num_fields, fields, state);
591 int MINIDRIVER(interface_jtag_add_ir_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
599 /* allocate memory for a new list member */
600 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
602 jtag_queue_command(cmd);
604 cmd->type = JTAG_SCAN;
606 /* allocate memory for ir scan command */
607 cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
608 cmd->cmd.scan->ir_scan = true;
609 x = jtag_NumEnabledTaps();
610 cmd->cmd.scan->num_fields = x; /* one field per device */
611 cmd->cmd.scan->fields = cmd_queue_alloc(x * sizeof(scan_field_t));
612 cmd->cmd.scan->end_state = state;
619 /* do this here so it is not forgotten */
620 tap = jtag_NextEnabledTap(tap);
626 assert(nth_tap < x );
628 scan_size = tap->ir_length;
629 cmd->cmd.scan->fields[nth_tap].tap = tap;
630 cmd->cmd.scan->fields[nth_tap].num_bits = scan_size;
631 cmd->cmd.scan->fields[nth_tap].in_value = NULL; /* do not collect input for tap's in bypass */
633 /* search the list */
634 for (j = 0; j < num_fields; j++)
636 if (tap == fields[j].tap)
639 cmd->cmd.scan->fields[nth_tap].in_value = fields[j].in_value;
640 cmd->cmd.scan->fields[nth_tap].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
649 /* if a tap isn't listed, set it to BYPASS */
650 cmd->cmd.scan->fields[nth_tap].out_value = buf_set_ones(cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
654 /* update device information */
655 buf_cpy(cmd->cmd.scan->fields[nth_tap].out_value, tap->cur_instr, scan_size);
657 assert(nth_tap == (x-1));
662 void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
668 retval=interface_jtag_add_plain_ir_scan(num_fields, fields, cmd_queue_end_state);
669 if (retval!=ERROR_OK)
673 int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
675 /* allocate memory for a new list member */
677 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
679 jtag_queue_command(cmd);
681 cmd->type = JTAG_SCAN;
683 /* allocate memory for ir scan command */
684 cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
685 cmd->cmd.scan->ir_scan = true;
686 cmd->cmd.scan->num_fields = num_fields;
687 cmd->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
688 cmd->cmd.scan->end_state = state;
690 for (int i = 0; i < num_fields; i++)
692 int num_bits = fields[i].num_bits;
693 int num_bytes = CEIL(fields[i].num_bits, 8);
694 cmd->cmd.scan->fields[i].tap = fields[i].tap;
695 cmd->cmd.scan->fields[i].num_bits = num_bits;
696 cmd->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
697 cmd->cmd.scan->fields[i].in_value = fields[i].in_value;
703 void jtag_add_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
709 retval=interface_jtag_add_dr_scan(num_fields, fields, cmd_queue_end_state);
710 if (retval!=ERROR_OK)
715 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
717 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
719 return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
722 static void jtag_add_scan_check(void (*jtag_add_scan)(int num_fields, scan_field_t *fields, tap_state_t state),
723 int num_fields, scan_field_t *fields, tap_state_t state)
725 for (int i=0; i<num_fields; i++)
727 fields[i].allocated=0;
728 fields[i].modified=0;
729 if ((fields[i].check_value!=NULL)&&(fields[i].in_value==NULL))
731 fields[i].modified=1;
732 /* we need storage space... */
733 #ifdef HAVE_JTAG_MINIDRIVER_H
734 if (fields[i].num_bits<=32)
736 /* This is enough space and we're executing this synchronously */
737 fields[i].in_value=fields[i].intmp;
740 fields[i].in_value=(u8 *)malloc(CEIL(fields[i].num_bits, 8));
741 fields[i].allocated=1;
744 fields[i].in_value=(u8 *)cmd_queue_alloc(CEIL(fields[i].num_bits, 8));
749 jtag_add_scan(num_fields, fields, state);
751 for (int i=0; i<num_fields; i++)
753 if ((fields[i].check_value!=NULL)&&(fields[i].in_value!=NULL))
755 /* this is synchronous for a minidriver */
756 jtag_add_callback4(jtag_check_value_mask_callback, fields[i].in_value, (jtag_callback_data_t)fields[i].check_value, (jtag_callback_data_t)fields[i].check_mask, (jtag_callback_data_t)fields[i].num_bits);
758 if (fields[i].allocated)
760 free(fields[i].in_value);
762 if (fields[i].modified)
764 fields[i].in_value=NULL;
769 void jtag_add_dr_scan_check(int num_fields, scan_field_t *fields, tap_state_t state)
773 jtag_add_scan_check(jtag_add_dr_scan, num_fields, fields, state);
776 jtag_add_dr_scan(num_fields, fields, state);
780 int MINIDRIVER(interface_jtag_add_dr_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
784 int bypass_devices = 0;
790 /* count devices in bypass */
794 tap = jtag_NextEnabledTap(tap);
803 /* allocate memory for a new list member */
805 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
807 jtag_queue_command(cmd);
809 cmd->type = JTAG_SCAN;
811 /* allocate memory for dr scan command */
812 cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
813 cmd->cmd.scan->ir_scan = false;
814 cmd->cmd.scan->num_fields = num_fields + bypass_devices;
815 cmd->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
816 cmd->cmd.scan->end_state = state;
822 tap = jtag_NextEnabledTap(tap);
827 cmd->cmd.scan->fields[field_count].tap = tap;
829 for (j = 0; j < num_fields; j++)
831 if (tap == fields[j].tap)
834 scan_size = fields[j].num_bits;
835 cmd->cmd.scan->fields[field_count].num_bits = scan_size;
836 cmd->cmd.scan->fields[field_count].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
837 cmd->cmd.scan->fields[field_count].in_value = fields[j].in_value;
843 #ifdef _DEBUG_JTAG_IO_
844 /* if a device isn't listed, the BYPASS register should be selected */
847 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
851 /* program the scan field to 1 bit length, and ignore it's value */
852 cmd->cmd.scan->fields[field_count].num_bits = 1;
853 cmd->cmd.scan->fields[field_count].out_value = NULL;
854 cmd->cmd.scan->fields[field_count].in_value = NULL;
859 #ifdef _DEBUG_JTAG_IO_
860 /* if a device is listed, the BYPASS register must not be selected */
863 LOG_ERROR("BUG: scan data for a device in BYPASS");
870 /* field_count represents the true number of fields setup*/
871 cmd->cmd.scan->num_fields = field_count;
875 void MINIDRIVER(interface_jtag_add_dr_out)(jtag_tap_t *target_tap,
879 tap_state_t end_state)
884 int bypass_devices = 0;
888 /* count devices in bypass */
892 tap = jtag_NextEnabledTap(tap);
901 /* allocate memory for a new list member */
902 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
904 jtag_queue_command(cmd);
906 cmd->type = JTAG_SCAN;
908 /* allocate memory for dr scan command */
909 cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
910 cmd->cmd.scan->ir_scan = false;
911 cmd->cmd.scan->num_fields = num_fields + bypass_devices;
912 cmd->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
913 cmd->cmd.scan->end_state = end_state;
918 tap = jtag_NextEnabledTap(tap);
923 cmd->cmd.scan->fields[field_count].tap = tap;
925 if (tap == target_tap)
928 #ifdef _DEBUG_JTAG_IO_
929 /* if a device is listed, the BYPASS register must not be selected */
932 LOG_ERROR("BUG: scan data for a device in BYPASS");
936 for (j = 0; j < num_fields; j++)
939 scan_size = num_bits[j];
940 buf_set_u32(out_value, 0, scan_size, value[j]);
941 cmd->cmd.scan->fields[field_count].num_bits = scan_size;
942 cmd->cmd.scan->fields[field_count].out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
943 cmd->cmd.scan->fields[field_count].in_value = NULL;
948 #ifdef _DEBUG_JTAG_IO_
949 /* if a device isn't listed, the BYPASS register should be selected */
952 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
956 /* program the scan field to 1 bit length, and ignore it's value */
957 cmd->cmd.scan->fields[field_count].num_bits = 1;
958 cmd->cmd.scan->fields[field_count].out_value = NULL;
959 cmd->cmd.scan->fields[field_count].in_value = NULL;
965 void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
971 retval=interface_jtag_add_plain_dr_scan(num_fields, fields, cmd_queue_end_state);
972 if (retval!=ERROR_OK)
976 int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
978 /* allocate memory for a new list member */
979 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
981 jtag_queue_command(cmd);
983 cmd->type = JTAG_SCAN;
985 /* allocate memory for scan command */
986 cmd->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
987 cmd->cmd.scan->ir_scan = false;
988 cmd->cmd.scan->num_fields = num_fields;
989 cmd->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
990 cmd->cmd.scan->end_state = state;
992 for (int i = 0; i < num_fields; i++)
994 int num_bits = fields[i].num_bits;
995 int num_bytes = CEIL(fields[i].num_bits, 8);
996 cmd->cmd.scan->fields[i].tap = fields[i].tap;
997 cmd->cmd.scan->fields[i].num_bits = num_bits;
998 cmd->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
999 cmd->cmd.scan->fields[i].in_value = fields[i].in_value;
1005 void jtag_add_tlr(void)
1007 jtag_prelude(TAP_RESET);
1010 retval=interface_jtag_add_tlr();
1011 if (retval!=ERROR_OK)
1015 int MINIDRIVER(interface_jtag_add_tlr)(void)
1017 tap_state_t state = TAP_RESET;
1019 /* allocate memory for a new list member */
1020 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1022 jtag_queue_command(cmd);
1024 cmd->type = JTAG_STATEMOVE;
1026 cmd->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1027 cmd->cmd.statemove->end_state = state;
1032 void jtag_add_pathmove(int num_states, tap_state_t *path)
1034 tap_state_t cur_state = cmd_queue_cur_state;
1038 /* the last state has to be a stable state */
1039 if (!tap_is_state_stable(path[num_states - 1]))
1041 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
1045 for (i=0; i<num_states; i++)
1047 if (path[i] == TAP_RESET)
1049 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
1053 if ( tap_state_transition(cur_state, true) != path[i]
1054 && tap_state_transition(cur_state, false) != path[i])
1056 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
1059 cur_state = path[i];
1064 retval = interface_jtag_add_pathmove(num_states, path);
1065 cmd_queue_cur_state = path[num_states - 1];
1066 if (retval!=ERROR_OK)
1070 int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, tap_state_t *path)
1072 /* allocate memory for a new list member */
1073 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1075 jtag_queue_command(cmd);
1077 cmd->type = JTAG_PATHMOVE;
1079 cmd->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
1080 cmd->cmd.pathmove->num_states = num_states;
1081 cmd->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);
1083 for (int i = 0; i < num_states; i++)
1084 cmd->cmd.pathmove->path[i] = path[i];
1089 int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, tap_state_t state)
1091 /* allocate memory for a new list member */
1092 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1094 jtag_queue_command(cmd);
1096 cmd->type = JTAG_RUNTEST;
1098 cmd->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
1099 cmd->cmd.runtest->num_cycles = num_cycles;
1100 cmd->cmd.runtest->end_state = state;
1105 void jtag_add_runtest(int num_cycles, tap_state_t state)
1109 jtag_prelude(state);
1111 /* executed by sw or hw fifo */
1112 retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
1113 if (retval!=ERROR_OK)
1118 int MINIDRIVER(interface_jtag_add_clocks)( int num_cycles )
1120 /* allocate memory for a new list member */
1121 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1123 jtag_queue_command(cmd);
1125 cmd->type = JTAG_STABLECLOCKS;
1127 cmd->cmd.stableclocks = cmd_queue_alloc(sizeof(stableclocks_command_t));
1128 cmd->cmd.stableclocks->num_cycles = num_cycles;
1133 void jtag_add_clocks( int num_cycles )
1137 if( !tap_is_state_stable(cmd_queue_cur_state) )
1139 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
1140 tap_state_name(cmd_queue_cur_state) );
1141 jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
1145 if( num_cycles > 0 )
1149 retval = interface_jtag_add_clocks(num_cycles);
1150 if (retval != ERROR_OK)
1155 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
1157 int trst_with_tlr = 0;
1160 /* FIX!!! there are *many* different cases here. A better
1161 * approach is needed for legal combinations of transitions...
1163 if ((jtag_reset_config & RESET_HAS_SRST)&&
1164 (jtag_reset_config & RESET_HAS_TRST)&&
1165 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
1167 if (((req_tlr_or_trst&&!jtag_trst)||
1168 (!req_tlr_or_trst&&jtag_trst))&&
1169 ((req_srst&&!jtag_srst)||
1170 (!req_srst&&jtag_srst)))
1172 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
1173 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
1177 /* Make sure that jtag_reset_config allows the requested reset */
1178 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
1179 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
1181 LOG_ERROR("BUG: requested reset would assert trst");
1182 jtag_error=ERROR_FAIL;
1186 /* if TRST pulls SRST, we reset with TAP T-L-R */
1187 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
1192 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
1194 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
1195 jtag_error=ERROR_FAIL;
1199 if (req_tlr_or_trst)
1201 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
1213 jtag_srst = req_srst;
1215 retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
1216 if (retval!=ERROR_OK)
1224 LOG_DEBUG("SRST line asserted");
1228 LOG_DEBUG("SRST line released");
1229 if (jtag_nsrst_delay)
1230 jtag_add_sleep(jtag_nsrst_delay * 1000);
1235 LOG_DEBUG("JTAG reset with RESET instead of TRST");
1236 jtag_add_end_state(TAP_RESET);
1238 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1244 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1245 * and inform possible listeners about this
1247 LOG_DEBUG("TRST line asserted");
1248 cmd_queue_cur_state = TAP_RESET;
1249 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1253 if (jtag_ntrst_delay)
1254 jtag_add_sleep(jtag_ntrst_delay * 1000);
1258 int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
1260 /* allocate memory for a new list member */
1261 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1263 jtag_queue_command(cmd);
1265 cmd->type = JTAG_RESET;
1267 cmd->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
1268 cmd->cmd.reset->trst = req_trst;
1269 cmd->cmd.reset->srst = req_srst;
1274 void jtag_add_end_state(tap_state_t state)
1276 cmd_queue_end_state = state;
1277 if ((cmd_queue_end_state == TAP_DRSHIFT)||(cmd_queue_end_state == TAP_IRSHIFT))
1279 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
1283 int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
1285 /* allocate memory for a new list member */
1286 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1288 jtag_queue_command(cmd);
1290 cmd->type = JTAG_SLEEP;
1292 cmd->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
1293 cmd->cmd.sleep->us = us;
1298 void jtag_add_sleep(u32 us)
1300 keep_alive(); /* we might be running on a very slow JTAG clk */
1301 int retval=interface_jtag_add_sleep(us);
1302 if (retval!=ERROR_OK)
1307 int jtag_scan_size(scan_command_t *cmd)
1312 /* count bits in scan command */
1313 for (i = 0; i < cmd->num_fields; i++)
1315 bit_count += cmd->fields[i].num_bits;
1321 int jtag_build_buffer(scan_command_t *cmd, u8 **buffer)
1326 bit_count = jtag_scan_size(cmd);
1327 *buffer = calloc(1,CEIL(bit_count, 8));
1331 #ifdef _DEBUG_JTAG_IO_
1332 LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
1335 for (i = 0; i < cmd->num_fields; i++)
1337 if (cmd->fields[i].out_value)
1339 #ifdef _DEBUG_JTAG_IO_
1340 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);
1342 buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
1343 #ifdef _DEBUG_JTAG_IO_
1344 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
1350 #ifdef _DEBUG_JTAG_IO_
1351 LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
1355 bit_count += cmd->fields[i].num_bits;
1358 #ifdef _DEBUG_JTAG_IO_
1359 //LOG_DEBUG("bit_count totalling: %i", bit_count );
1365 int jtag_read_buffer(u8 *buffer, scan_command_t *cmd)
1371 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1374 for (i = 0; i < cmd->num_fields; i++)
1376 /* if neither in_value nor in_handler
1377 * are specified we don't have to examine this field
1379 if (cmd->fields[i].in_value)
1381 int num_bits = cmd->fields[i].num_bits;
1382 u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
1384 #ifdef _DEBUG_JTAG_IO_
1385 char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1386 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
1390 if (cmd->fields[i].in_value)
1392 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
1397 bit_count += cmd->fields[i].num_bits;
1403 static const char *jtag_tap_name(jtag_tap_t *tap)
1405 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
1408 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
1410 int retval = ERROR_OK;
1412 int compare_failed = 0;
1415 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
1417 compare_failed = buf_cmp(captured, in_check_value, num_bits);
1419 if (compare_failed){
1420 /* An error handler could have caught the failing check
1421 * only report a problem when there wasn't a handler, or if the handler
1422 * acknowledged the error
1425 LOG_WARNING("TAP %s:",
1426 jtag_tap_name(field->tap));
1430 char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1431 char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1435 char *in_check_mask_char;
1436 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1437 LOG_WARNING("value captured during scan didn't pass the requested check:");
1438 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1439 captured_char, in_check_value_char, in_check_mask_char);
1440 free(in_check_mask_char);
1444 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);
1447 free(captured_char);
1448 free(in_check_value_char);
1450 retval = ERROR_JTAG_QUEUE_FAILED;
1457 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
1459 assert(field->in_value != NULL);
1463 /* no checking to do */
1467 jtag_execute_queue_noclear();
1469 int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
1470 jtag_set_error(retval);
1475 enum scan_type jtag_scan_type(scan_command_t *cmd)
1480 for (i = 0; i < cmd->num_fields; i++)
1482 if (cmd->fields[i].in_value)
1484 if (cmd->fields[i].out_value)
1492 #ifndef HAVE_JTAG_MINIDRIVER_H
1493 /* add callback to end of queue */
1494 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)
1496 struct jtag_callback_entry *entry=cmd_queue_alloc(sizeof(struct jtag_callback_entry));
1499 entry->callback=callback;
1505 if (jtag_callback_queue_head==NULL)
1507 jtag_callback_queue_head=entry;
1508 jtag_callback_queue_tail=entry;
1511 jtag_callback_queue_tail->next=entry;
1512 jtag_callback_queue_tail=entry;
1517 static int jtag_convert_to_callback4(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
1519 ((jtag_callback1_t)data1)(in);
1523 void jtag_add_callback(jtag_callback1_t callback, u8 *in)
1525 jtag_add_callback4(jtag_convert_to_callback4, in, (jtag_callback_data_t)callback, 0, 0);
1529 #ifndef HAVE_JTAG_MINIDRIVER_H
1531 int interface_jtag_execute_queue(void)
1537 LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
1541 retval = jtag->execute_queue();
1543 if (retval == ERROR_OK)
1545 struct jtag_callback_entry *entry;
1546 for (entry=jtag_callback_queue_head; entry!=NULL; entry=entry->next)
1548 retval=entry->callback(entry->in, entry->data1, entry->data2, entry->data3);
1549 if (retval!=ERROR_OK)
1556 jtag_callback_queue_head = NULL;
1557 jtag_callback_queue_tail = NULL;
1559 jtag_command_queue = NULL;
1560 last_command_pointer = &jtag_command_queue;
1566 void jtag_execute_queue_noclear(void)
1568 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
1569 * E.g. a JTAG over TCP/IP or USB....
1571 jtag_flush_queue_count++;
1573 int retval=interface_jtag_execute_queue();
1574 /* we keep the first error */
1575 if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
1581 int jtag_execute_queue(void)
1584 jtag_execute_queue_noclear();
1586 jtag_error=ERROR_OK;
1590 int jtag_reset_callback(enum jtag_event event, void *priv)
1592 jtag_tap_t *tap = priv;
1596 if (event == JTAG_TRST_ASSERTED)
1598 buf_set_ones(tap->cur_instr, tap->ir_length);
1605 void jtag_sleep(u32 us)
1607 alive_sleep(us/1000);
1610 /* Try to examine chain layout according to IEEE 1149.1 §12
1612 int jtag_examine_chain(void)
1616 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1619 int device_count = 0;
1620 u8 zero_check = 0x0;
1621 u8 one_check = 0xff;
1624 field.num_bits = sizeof(idcode_buffer) * 8;
1625 field.out_value = idcode_buffer;
1627 field.in_value = idcode_buffer;
1632 for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1634 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1637 jtag_add_plain_dr_scan(1, &field, TAP_RESET);
1638 jtag_execute_queue();
1640 for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1642 zero_check |= idcode_buffer[i];
1643 one_check &= idcode_buffer[i];
1646 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1647 if ((zero_check == 0x00) || (one_check == 0xff))
1649 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1650 return ERROR_JTAG_INIT_FAILED;
1653 /* point at the 1st tap */
1654 tap = jtag_NextEnabledTap(NULL);
1656 LOG_ERROR("JTAG: No taps enabled?");
1657 return ERROR_JTAG_INIT_FAILED;
1660 for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1662 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1663 if ((idcode & 1) == 0)
1665 /* LSB must not be 0, this indicates a device in bypass */
1666 LOG_WARNING("Tap/Device does not have IDCODE");
1677 /* some devices, such as AVR will output all 1's instead of TDI
1678 input value at end of chain. */
1679 if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1682 /* End of chain (invalid manufacturer ID)
1684 * The JTAG examine is the very first thing that happens
1686 * A single JTAG device requires only 64 bits to be read back correctly.
1688 * The code below adds a check that the rest of the data scanned (640 bits)
1689 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1691 * earlier and gives more helpful/explicit error messages.
1693 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1695 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1696 if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1698 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1706 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1707 manufacturer = EXTRACT_MFG(idcode);
1708 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1709 part = EXTRACT_PART(idcode);
1710 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1711 version = EXTRACT_VER(idcode);
1713 LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1714 ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1715 idcode, manufacturer, part, version);
1721 tap->idcode = idcode;
1723 if (tap->expected_ids_cnt > 0) {
1724 /* Loop over the expected identification codes and test for a match */
1726 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1727 if( tap->idcode == tap->expected_ids[ii] ){
1732 /* If none of the expected ids matched, log an error */
1733 if (ii == tap->expected_ids_cnt) {
1734 LOG_ERROR("JTAG tap: %s got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1737 EXTRACT_MFG( tap->idcode ),
1738 EXTRACT_PART( tap->idcode ),
1739 EXTRACT_VER( tap->idcode ) );
1740 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1741 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1744 tap->expected_ids_cnt,
1745 tap->expected_ids[ii],
1746 EXTRACT_MFG( tap->expected_ids[ii] ),
1747 EXTRACT_PART( tap->expected_ids[ii] ),
1748 EXTRACT_VER( tap->expected_ids[ii] ) );
1751 return ERROR_JTAG_INIT_FAILED;
1753 LOG_INFO("JTAG Tap/device matched");
1757 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1761 tap = jtag_NextEnabledTap(tap);
1766 /* see if number of discovered devices matches configuration */
1767 if (device_count != jtag_NumEnabledTaps())
1769 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1770 device_count, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1771 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1772 return ERROR_JTAG_INIT_FAILED;
1778 int jtag_validate_chain(void)
1781 int total_ir_length = 0;
1787 total_ir_length = 0;
1789 tap = jtag_NextEnabledTap(tap);
1793 total_ir_length += tap->ir_length;
1796 total_ir_length += 2;
1797 ir_test = malloc(CEIL(total_ir_length, 8));
1798 buf_set_ones(ir_test, total_ir_length);
1801 field.num_bits = total_ir_length;
1802 field.out_value = ir_test;
1803 field.in_value = ir_test;
1806 jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1807 jtag_execute_queue();
1813 tap = jtag_NextEnabledTap(tap);
1818 val = buf_get_u32(ir_test, chain_pos, 2);
1821 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1822 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);
1825 return ERROR_JTAG_INIT_FAILED;
1827 chain_pos += tap->ir_length;
1830 val = buf_get_u32(ir_test, chain_pos, 2);
1833 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1834 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);
1837 return ERROR_JTAG_INIT_FAILED;
1845 enum jtag_tap_cfg_param {
1849 static Jim_Nvp nvp_config_opts[] = {
1850 { .name = "-event", .value = JCFG_EVENT },
1852 { .name = NULL, .value = -1 }
1855 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1861 /* parse config or cget options */
1862 while (goi->argc > 0) {
1863 Jim_SetEmptyResult (goi->interp);
1865 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1867 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1873 if (goi->argc == 0) {
1874 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1878 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1880 Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1884 if (goi->isconfigure) {
1885 if (goi->argc != 1) {
1886 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1890 if (goi->argc != 0) {
1891 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1897 jtag_tap_event_action_t *jteap;
1899 jteap = tap->event_action;
1900 /* replace existing? */
1902 if (jteap->event == (enum jtag_tap_event)n->value) {
1905 jteap = jteap->next;
1908 if (goi->isconfigure) {
1909 if (jteap == NULL) {
1911 jteap = calloc(1, sizeof (*jteap));
1913 jteap->event = n->value;
1914 Jim_GetOpt_Obj( goi, &o);
1916 Jim_DecrRefCount(interp, jteap->body);
1918 jteap->body = Jim_DuplicateObj(goi->interp, o);
1919 Jim_IncrRefCount(jteap->body);
1921 /* add to head of event list */
1922 jteap->next = tap->event_action;
1923 tap->event_action = jteap;
1924 Jim_SetEmptyResult(goi->interp);
1927 if (jteap == NULL) {
1928 Jim_SetEmptyResult(goi->interp);
1930 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1937 } /* while (goi->argc) */
1942 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1952 const Jim_Nvp opts[] = {
1953 #define NTAP_OPT_IRLEN 0
1954 { .name = "-irlen" , .value = NTAP_OPT_IRLEN },
1955 #define NTAP_OPT_IRMASK 1
1956 { .name = "-irmask" , .value = NTAP_OPT_IRMASK },
1957 #define NTAP_OPT_IRCAPTURE 2
1958 { .name = "-ircapture" , .value = NTAP_OPT_IRCAPTURE },
1959 #define NTAP_OPT_ENABLED 3
1960 { .name = "-enable" , .value = NTAP_OPT_ENABLED },
1961 #define NTAP_OPT_DISABLED 4
1962 { .name = "-disable" , .value = NTAP_OPT_DISABLED },
1963 #define NTAP_OPT_EXPECTED_ID 5
1964 { .name = "-expected-id" , .value = NTAP_OPT_EXPECTED_ID },
1965 { .name = NULL , .value = -1 },
1968 pTap = malloc( sizeof(jtag_tap_t) );
1969 memset( pTap, 0, sizeof(*pTap) );
1971 Jim_SetResult_sprintf( goi->interp, "no memory");
1975 * we expect CHIP + TAP + OPTIONS
1977 if( goi->argc < 3 ){
1978 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
1981 Jim_GetOpt_String( goi, &cp, NULL );
1982 pTap->chip = strdup(cp);
1984 Jim_GetOpt_String( goi, &cp, NULL );
1985 pTap->tapname = strdup(cp);
1987 /* name + dot + name + null */
1988 x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
1990 sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
1991 pTap->dotted_name = cp;
1993 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1994 pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
1996 /* default is enabled */
1999 /* deal with options */
2000 #define NTREQ_IRLEN 1
2001 #define NTREQ_IRCAPTURE 2
2002 #define NTREQ_IRMASK 4
2004 /* clear them as we find them */
2005 reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
2008 e = Jim_GetOpt_Nvp( goi, opts, &n );
2010 Jim_GetOpt_NvpUnknown( goi, opts, 0 );
2013 LOG_DEBUG("Processing option: %s", n->name );
2015 case NTAP_OPT_ENABLED:
2018 case NTAP_OPT_DISABLED:
2021 case NTAP_OPT_EXPECTED_ID:
2023 u32 *new_expected_ids;
2025 e = Jim_GetOpt_Wide( goi, &w );
2027 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
2031 new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
2032 if (new_expected_ids == NULL) {
2033 Jim_SetResult_sprintf( goi->interp, "no memory");
2037 memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
2039 new_expected_ids[pTap->expected_ids_cnt] = w;
2041 free(pTap->expected_ids);
2042 pTap->expected_ids = new_expected_ids;
2043 pTap->expected_ids_cnt++;
2046 case NTAP_OPT_IRLEN:
2047 case NTAP_OPT_IRMASK:
2048 case NTAP_OPT_IRCAPTURE:
2049 e = Jim_GetOpt_Wide( goi, &w );
2051 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
2054 if( (w < 0) || (w > 0xffff) ){
2056 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
2057 n->name, (int)(w), (int)(w));
2061 case NTAP_OPT_IRLEN:
2062 pTap->ir_length = w;
2063 reqbits &= (~(NTREQ_IRLEN));
2065 case NTAP_OPT_IRMASK:
2066 pTap->ir_capture_mask = w;
2067 reqbits &= (~(NTREQ_IRMASK));
2069 case NTAP_OPT_IRCAPTURE:
2070 pTap->ir_capture_value = w;
2071 reqbits &= (~(NTREQ_IRCAPTURE));
2074 } /* switch(n->value) */
2075 } /* while( goi->argc ) */
2077 /* Did we get all the options? */
2080 Jim_SetResult_sprintf( goi->interp,
2081 "newtap: %s missing required parameters",
2083 /* TODO: Tell user what is missing :-( */
2084 /* no memory leaks pelase */
2085 free(((void *)(pTap->expected_ids)));
2086 free(((void *)(pTap->chip)));
2087 free(((void *)(pTap->tapname)));
2088 free(((void *)(pTap->dotted_name)));
2089 free(((void *)(pTap)));
2093 pTap->expected = malloc( pTap->ir_length );
2094 pTap->expected_mask = malloc( pTap->ir_length );
2095 pTap->cur_instr = malloc( pTap->ir_length );
2097 buf_set_u32( pTap->expected,
2100 pTap->ir_capture_value );
2101 buf_set_u32( pTap->expected_mask,
2104 pTap->ir_capture_mask );
2105 buf_set_ones( pTap->cur_instr,
2110 jtag_register_event_callback(jtag_reset_callback, pTap );
2112 ppTap = &(jtag_all_taps);
2113 while( (*ppTap) != NULL ){
2114 ppTap = &((*ppTap)->next_tap);
2118 static int n_taps = 0;
2119 pTap->abs_chain_position = n_taps++;
2121 LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
2122 (*ppTap)->dotted_name,
2123 (*ppTap)->abs_chain_position,
2124 (*ppTap)->ir_length,
2125 (*ppTap)->ir_capture_value,
2126 (*ppTap)->ir_capture_mask );
2131 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
2137 struct command_context_s *context;
2141 JTAG_CMD_INIT_RESET,
2144 JTAG_CMD_TAPDISABLE,
2145 JTAG_CMD_TAPISENABLED,
2150 const Jim_Nvp jtag_cmds[] = {
2151 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
2152 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
2153 { .name = "newtap" , .value = JTAG_CMD_NEWTAP },
2154 { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED },
2155 { .name = "tapenable" , .value = JTAG_CMD_TAPENABLE },
2156 { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE },
2157 { .name = "configure" , .value = JTAG_CMD_CONFIGURE },
2158 { .name = "cget" , .value = JTAG_CMD_CGET },
2160 { .name = NULL, .value = -1 },
2163 context = Jim_GetAssocData(interp, "context");
2164 /* go past the command */
2165 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
2167 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
2169 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
2172 Jim_SetEmptyResult( goi.interp );
2174 case JTAG_CMD_INTERFACE:
2175 /* return the name of the interface */
2176 /* TCL code might need to know the exact type... */
2177 /* FUTURE: we allow this as a means to "set" the interface. */
2178 if( goi.argc != 0 ){
2179 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2182 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
2184 case JTAG_CMD_INIT_RESET:
2185 if( goi.argc != 0 ){
2186 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2189 e = jtag_init_reset(context);
2190 if( e != ERROR_OK ){
2191 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
2195 case JTAG_CMD_NEWTAP:
2196 return jim_newtap_cmd( &goi );
2198 case JTAG_CMD_TAPISENABLED:
2199 case JTAG_CMD_TAPENABLE:
2200 case JTAG_CMD_TAPDISABLE:
2201 if( goi.argc != 1 ){
2202 Jim_SetResultString( goi.interp, "Too many parameters",-1 );
2208 t = jtag_TapByJimObj( goi.interp, goi.argv[0] );
2213 case JTAG_CMD_TAPISENABLED:
2216 case JTAG_CMD_TAPENABLE:
2217 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
2221 case JTAG_CMD_TAPDISABLE:
2222 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
2227 Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
2234 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
2241 Jim_GetOpt_Obj(&goi, &o);
2242 t = jtag_TapByJimObj( goi.interp, o );
2247 goi.isconfigure = 0;
2248 return jtag_tap_configure_cmd( &goi, t);
2252 case JTAG_CMD_CONFIGURE:
2254 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
2261 Jim_GetOpt_Obj(&goi, &o);
2262 t = jtag_TapByJimObj( goi.interp, o );
2267 goi.isconfigure = 1;
2268 return jtag_tap_configure_cmd( &goi, t);
2275 int jtag_register_commands(struct command_context_s *cmd_ctx)
2277 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
2279 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
2280 COMMAND_CONFIG, "try to configure interface");
2281 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
2282 COMMAND_ANY, "set jtag speed (if supported)");
2283 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
2284 COMMAND_ANY, "same as jtag_speed, except it takes maximum khz as arguments. 0 KHz = RTCK.");
2285 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
2286 COMMAND_CONFIG, "jtag_device <ir_length> <ir_expected> <ir_mask>");
2287 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
2289 "[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]");
2290 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
2291 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
2292 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
2293 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
2295 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
2296 COMMAND_EXEC, "print current scan chain configuration");
2298 register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
2299 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
2300 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
2301 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
2302 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
2303 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
2304 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
2305 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
2306 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
2307 register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
2309 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
2310 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
2311 register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
2312 COMMAND_ANY, "verify value capture <enable|disable>");
2316 int jtag_interface_init(struct command_context_s *cmd_ctx)
2321 if (!jtag_interface)
2323 /* nothing was previously specified by "interface" command */
2324 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
2325 return ERROR_JTAG_INVALID_INTERFACE;
2329 jtag_interface->khz(speed_khz, &jtag_speed);
2333 if (jtag_interface->init() != ERROR_OK)
2334 return ERROR_JTAG_INIT_FAILED;
2336 jtag = jtag_interface;
2340 static int jtag_init_inner(struct command_context_s *cmd_ctx)
2345 LOG_DEBUG("Init JTAG chain");
2347 tap = jtag_NextEnabledTap(NULL);
2349 LOG_ERROR("There are no enabled taps?");
2350 return ERROR_JTAG_INIT_FAILED;
2354 if ((retval=jtag_execute_queue())!=ERROR_OK)
2357 /* examine chain first, as this could discover the real chain layout */
2358 if (jtag_examine_chain() != ERROR_OK)
2360 LOG_ERROR("trying to validate configured JTAG chain anyway...");
2363 if (jtag_validate_chain() != ERROR_OK)
2365 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
2371 int jtag_init_reset(struct command_context_s *cmd_ctx)
2375 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2378 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
2380 /* Reset can happen after a power cycle.
2382 * Ideally we would only assert TRST or run RESET before the target reset.
2384 * However w/srst_pulls_trst, trst is asserted together with the target
2385 * reset whether we want it or not.
2387 * NB! Some targets have JTAG circuitry disabled until a
2388 * trst & srst has been asserted.
2390 * NB! here we assume nsrst/ntrst delay are sufficient!
2392 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
2395 jtag_add_reset(1, 0); /* RESET or TRST */
2396 if (jtag_reset_config & RESET_HAS_SRST)
2398 jtag_add_reset(1, 1);
2399 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
2400 jtag_add_reset(0, 1);
2402 jtag_add_reset(0, 0);
2403 if ((retval = jtag_execute_queue()) != ERROR_OK)
2406 /* Check that we can communication on the JTAG chain + eventually we want to
2407 * be able to perform enumeration only after OpenOCD has started
2408 * telnet and GDB server
2410 * That would allow users to more easily perform any magic they need to before
2413 return jtag_init_inner(cmd_ctx);
2416 int jtag_init(struct command_context_s *cmd_ctx)
2419 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2421 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
2425 return jtag_init_reset(cmd_ctx);
2428 static int default_khz(int khz, int *jtag_speed)
2430 LOG_ERROR("Translation from khz to jtag_speed not implemented");
2434 static int default_speed_div(int speed, int *khz)
2436 LOG_ERROR("Translation from jtag_speed to khz not implemented");
2440 static int default_power_dropout(int *dropout)
2442 *dropout=0; /* by default we can't detect power dropout */
2446 static int default_srst_asserted(int *srst_asserted)
2448 *srst_asserted=0; /* by default we can't detect srst asserted */
2452 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2457 /* check whether the interface is already configured */
2460 LOG_WARNING("Interface already configured, ignoring");
2464 /* interface name is a mandatory argument */
2465 if (argc < 1 || args[0][0] == '\0')
2467 return ERROR_COMMAND_SYNTAX_ERROR;
2470 for (i=0; jtag_interfaces[i]; i++)
2472 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
2474 if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
2479 jtag_interface = jtag_interfaces[i];
2481 if (jtag_interface->khz == NULL)
2483 jtag_interface->khz = default_khz;
2485 if (jtag_interface->speed_div == NULL)
2487 jtag_interface->speed_div = default_speed_div;
2489 if (jtag_interface->power_dropout == NULL)
2491 jtag_interface->power_dropout = default_power_dropout;
2493 if (jtag_interface->srst_asserted == NULL)
2495 jtag_interface->srst_asserted = default_srst_asserted;
2502 /* no valid interface was found (i.e. the configuration option,
2503 * didn't match one of the compiled-in interfaces
2505 LOG_ERROR("No valid jtag interface found (%s)", args[0]);
2506 LOG_ERROR("compiled-in jtag interfaces:");
2507 for (i = 0; jtag_interfaces[i]; i++)
2509 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
2512 return ERROR_JTAG_INVALID_INTERFACE;
2515 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2519 Jim_Obj *newargs[ 10 ];
2522 * argv[-1] = command
2523 * argv[ 0] = ir length
2524 * argv[ 1] = ir capture
2525 * argv[ 2] = ir mask
2526 * argv[ 3] = not actually used by anything but in the docs
2530 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2533 command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2534 command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2538 command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2539 command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2540 command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2541 command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
2543 newargs[0] = Jim_NewStringObj( interp, "jtag", -1 );
2544 newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
2545 sprintf( buf, "chip%d", jtag_NumTotalTaps() );
2546 newargs[2] = Jim_NewStringObj( interp, buf, -1 );
2547 sprintf( buf, "tap%d", jtag_NumTotalTaps() );
2548 newargs[3] = Jim_NewStringObj( interp, buf, -1 );
2549 newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 );
2550 newargs[5] = Jim_NewStringObj( interp, args[0], -1 );
2551 newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 );
2552 newargs[7] = Jim_NewStringObj( interp, args[1], -1 );
2553 newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 );
2554 newargs[9] = Jim_NewStringObj( interp, args[2], -1 );
2556 command_print( cmd_ctx, "NEW COMMAND:");
2557 sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
2558 Jim_GetString( newargs[0], NULL ),
2559 Jim_GetString( newargs[1], NULL ),
2560 Jim_GetString( newargs[2], NULL ),
2561 Jim_GetString( newargs[3], NULL ),
2562 Jim_GetString( newargs[4], NULL ),
2563 Jim_GetString( newargs[5], NULL ),
2564 Jim_GetString( newargs[6], NULL ),
2565 Jim_GetString( newargs[7], NULL ),
2566 Jim_GetString( newargs[8], NULL ),
2567 Jim_GetString( newargs[9], NULL ) );
2569 e = jim_jtag_command( interp, 10, newargs );
2571 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
2576 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2580 tap = jtag_all_taps;
2581 command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
2582 command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
2585 u32 expected, expected_mask, cur_instr, ii;
2586 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
2587 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
2588 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
2590 command_print(cmd_ctx,
2591 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2592 tap->abs_chain_position,
2594 tap->enabled ? 'Y' : 'n',
2596 (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
2602 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
2603 command_print(cmd_ctx, " | | | | 0x%08x | | | | ",
2604 tap->expected_ids[ii]);
2607 tap = tap->next_tap;
2613 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2616 return ERROR_COMMAND_SYNTAX_ERROR;
2620 if (strcmp(args[0], "none") == 0)
2621 jtag_reset_config = RESET_NONE;
2622 else if (strcmp(args[0], "trst_only") == 0)
2623 jtag_reset_config = RESET_HAS_TRST;
2624 else if (strcmp(args[0], "srst_only") == 0)
2625 jtag_reset_config = RESET_HAS_SRST;
2626 else if (strcmp(args[0], "trst_and_srst") == 0)
2627 jtag_reset_config = RESET_TRST_AND_SRST;
2630 LOG_ERROR("(1) invalid reset_config argument (%s), defaulting to none", args[0]);
2631 jtag_reset_config = RESET_NONE;
2632 return ERROR_INVALID_ARGUMENTS;
2638 if (strcmp(args[1], "separate") == 0)
2640 /* seperate reset lines - default */
2643 if (strcmp(args[1], "srst_pulls_trst") == 0)
2644 jtag_reset_config |= RESET_SRST_PULLS_TRST;
2645 else if (strcmp(args[1], "trst_pulls_srst") == 0)
2646 jtag_reset_config |= RESET_TRST_PULLS_SRST;
2647 else if (strcmp(args[1], "combined") == 0)
2648 jtag_reset_config |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2651 LOG_ERROR("(2) invalid reset_config argument (%s), defaulting to none", args[1]);
2652 jtag_reset_config = RESET_NONE;
2653 return ERROR_INVALID_ARGUMENTS;
2660 if (strcmp(args[2], "trst_open_drain") == 0)
2661 jtag_reset_config |= RESET_TRST_OPEN_DRAIN;
2662 else if (strcmp(args[2], "trst_push_pull") == 0)
2663 jtag_reset_config &= ~RESET_TRST_OPEN_DRAIN;
2666 LOG_ERROR("(3) invalid reset_config argument (%s) defaulting to none", args[2] );
2667 jtag_reset_config = RESET_NONE;
2668 return ERROR_INVALID_ARGUMENTS;
2674 if (strcmp(args[3], "srst_push_pull") == 0)
2675 jtag_reset_config |= RESET_SRST_PUSH_PULL;
2676 else if (strcmp(args[3], "srst_open_drain") == 0)
2677 jtag_reset_config &= ~RESET_SRST_PUSH_PULL;
2680 LOG_ERROR("(4) invalid reset_config argument (%s), defaulting to none", args[3]);
2681 jtag_reset_config = RESET_NONE;
2682 return ERROR_INVALID_ARGUMENTS;
2689 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2693 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2698 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
2704 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2708 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2713 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
2719 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2721 int retval=ERROR_OK;
2725 LOG_DEBUG("handle jtag speed");
2728 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2730 /* this command can be called during CONFIG,
2731 * in which case jtag isn't initialized */
2734 retval=jtag->speed(cur_speed);
2736 } else if (argc == 0)
2740 return ERROR_COMMAND_SYNTAX_ERROR;
2742 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2747 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2749 int retval=ERROR_OK;
2750 LOG_DEBUG("handle jtag khz");
2754 speed_khz = strtoul(args[0], NULL, 0);
2758 LOG_DEBUG("have interface set up");
2760 if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
2766 cur_speed = jtag_speed = speed_div1;
2768 retval=jtag->speed(cur_speed);
2777 return ERROR_COMMAND_SYNTAX_ERROR;
2782 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
2788 command_print(cmd_ctx, "RCLK - adaptive");
2791 command_print(cmd_ctx, "%d kHz", speed_khz);
2797 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2803 return ERROR_COMMAND_SYNTAX_ERROR;
2807 state = tap_state_by_name( args[0] );
2809 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2810 return ERROR_COMMAND_SYNTAX_ERROR;
2812 jtag_add_end_state(state);
2813 jtag_execute_queue();
2815 command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
2820 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2827 return ERROR_COMMAND_SYNTAX_ERROR;
2830 if (args[0][0] == '1')
2832 else if (args[0][0] == '0')
2836 return ERROR_COMMAND_SYNTAX_ERROR;
2839 if (args[1][0] == '1')
2841 else if (args[1][0] == '0')
2845 return ERROR_COMMAND_SYNTAX_ERROR;
2848 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2849 return ERROR_JTAG_INIT_FAILED;
2851 jtag_add_reset(trst, srst);
2852 jtag_execute_queue();
2857 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2861 return ERROR_COMMAND_SYNTAX_ERROR;
2864 jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
2865 jtag_execute_queue();
2871 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2874 scan_field_t *fields;
2876 tap_state_t endstate;
2878 if ((argc < 2) || (argc % 2))
2880 return ERROR_COMMAND_SYNTAX_ERROR;
2883 /* optional "-endstate" */
2885 /* at the end of the arguments. */
2887 endstate = cmd_queue_end_state;
2889 /* have at least one pair of numbers. */
2890 /* is last pair the magic text? */
2891 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2894 cpA = args[ argc-1 ];
2895 for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2896 cpS = tap_state_name( endstate );
2897 if( 0 == strcmp( cpA, cpS ) ){
2901 if( endstate >= TAP_NUM_STATES ){
2902 return ERROR_COMMAND_SYNTAX_ERROR;
2904 /* found - remove the last 2 args */
2910 int num_fields = argc / 2;
2912 fields = malloc(sizeof(scan_field_t) * num_fields);
2914 for (i = 0; i < num_fields; i++)
2916 tap = jtag_TapByString( args[i*2] );
2919 command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2922 int field_size = tap->ir_length;
2923 fields[i].tap = tap;
2924 fields[i].num_bits = field_size;
2925 fields[i].out_value = malloc(CEIL(field_size, 8));
2926 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2927 fields[i].in_value = NULL;
2930 /* did we have an endstate? */
2931 jtag_add_ir_scan(num_fields, fields, endstate);
2933 int retval=jtag_execute_queue();
2935 for (i = 0; i < num_fields; i++)
2936 free(fields[i].out_value);
2943 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2946 scan_field_t *fields;
2948 int field_count = 0;
2951 tap_state_t endstate;
2954 * args[2] = num_bits
2955 * args[3] = hex string
2956 * ... repeat num bits and hex string ...
2959 * args[N-2] = "-endstate"
2960 * args[N-1] = statename
2962 if ((argc < 4) || ((argc % 2)!=0))
2964 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2968 /* assume no endstate */
2969 endstate = cmd_queue_end_state;
2970 /* validate arguments as numbers */
2972 for (i = 2; i < argc; i+=2)
2977 e = Jim_GetLong(interp, args[i], &bits);
2978 /* If valid - try next arg */
2983 /* Not valid.. are we at the end? */
2984 if ( ((i+2) != argc) ){
2985 /* nope, then error */
2989 /* it could be: "-endstate FOO" */
2991 /* get arg as a string. */
2992 cp = Jim_GetString( args[i], NULL );
2993 /* is it the magic? */
2994 if( 0 == strcmp( "-endstate", cp ) ){
2995 /* is the statename valid? */
2996 cp = Jim_GetString( args[i+1], NULL );
2998 /* see if it is a valid state name */
2999 endstate = tap_state_by_name(cp);
3001 /* update the error message */
3002 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
3004 /* valid - so clear the error */
3006 /* and remove the last 2 args */
3011 /* Still an error? */
3013 return e; /* too bad */
3015 } /* validate args */
3017 tap = jtag_TapByJimObj( interp, args[1] );
3022 num_fields=(argc-2)/2;
3023 fields = malloc(sizeof(scan_field_t) * num_fields);
3024 for (i = 2; i < argc; i+=2)
3030 Jim_GetLong(interp, args[i], &bits);
3031 str = Jim_GetString(args[i+1], &len);
3033 fields[field_count].tap = tap;
3034 fields[field_count].num_bits = bits;
3035 fields[field_count].out_value = malloc(CEIL(bits, 8));
3036 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
3037 fields[field_count].in_value = fields[field_count].out_value;
3041 jtag_add_dr_scan(num_fields, fields, endstate);
3043 retval = jtag_execute_queue();
3044 if (retval != ERROR_OK)
3046 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
3051 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
3052 for (i = 2; i < argc; i+=2)
3057 Jim_GetLong(interp, args[i], &bits);
3058 str = buf_to_str(fields[field_count].in_value, bits, 16);
3059 free(fields[field_count].out_value);
3061 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
3066 Jim_SetResult(interp, list);
3074 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
3076 Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_flush_queue_count));
3082 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3086 if (strcmp(args[0], "enable") == 0)
3088 jtag_verify_capture_ir = 1;
3090 else if (strcmp(args[0], "disable") == 0)
3092 jtag_verify_capture_ir = 0;
3095 return ERROR_COMMAND_SYNTAX_ERROR;
3097 } else if (argc != 0)
3099 return ERROR_COMMAND_SYNTAX_ERROR;
3102 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
3107 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3111 if (strcmp(args[0], "enable") == 0)
3115 else if (strcmp(args[0], "disable") == 0)
3120 return ERROR_COMMAND_SYNTAX_ERROR;
3122 } else if (argc != 0)
3124 return ERROR_COMMAND_SYNTAX_ERROR;
3127 command_print(cmd_ctx, "verify jtag capture is %s", (jtag_verify) ? "enabled": "disabled");
3132 int jtag_power_dropout(int *dropout)
3134 return jtag->power_dropout(dropout);
3137 int jtag_srst_asserted(int *srst_asserted)
3139 return jtag->srst_asserted(srst_asserted);
3142 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
3144 jtag_tap_event_action_t * jteap;
3147 jteap = tap->event_action;
3151 if (jteap->event == e) {
3153 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
3156 Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
3157 Jim_GetString(jteap->body, NULL) );
3158 if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
3159 Jim_PrintErrorMessage(interp);
3163 jteap = jteap->next;
3167 LOG_DEBUG( "event %d %s - no action",
3169 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
3173 /*-----<Cable Helper API>---------------------------------------*/
3175 /* these Cable Helper API functions are all documented in the jtag.h header file,
3176 using a Doxygen format. And since Doxygen's configuration file "Doxyfile",
3177 is setup to prefer its docs in the header file, no documentation is here, for
3178 if it were, it would have to be doubly maintained.
3182 * @see tap_set_state() and tap_get_state() accessors.
3183 * Actual name is not important since accessors hide it.
3185 static tap_state_t state_follower = TAP_RESET;
3187 void tap_set_state_impl( tap_state_t new_state )
3189 /* this is the state we think the TAPs are in now, was cur_state */
3190 state_follower = new_state;
3193 tap_state_t tap_get_state()
3195 return state_follower;
3199 * @see tap_set_end_state() and tap_get_end_state() accessors.
3200 * Actual name is not important because accessors hide it.
3202 static tap_state_t end_state_follower = TAP_RESET;
3204 void tap_set_end_state( tap_state_t new_end_state )
3206 /* this is the state we think the TAPs will be in at completion of the
3207 current TAP operation, was end_state
3209 end_state_follower = new_end_state;
3212 tap_state_t tap_get_end_state()
3214 return end_state_follower;
3218 int tap_move_ndx( tap_state_t astate )
3220 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
3226 case TAP_RESET: ndx = 0; break;
3227 case TAP_DRSHIFT: ndx = 2; break;
3228 case TAP_DRPAUSE: ndx = 3; break;
3229 case TAP_IDLE: ndx = 1; break;
3230 case TAP_IRSHIFT: ndx = 4; break;
3231 case TAP_IRPAUSE: ndx = 5; break;
3233 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate) );
3241 /* tap_move[i][j]: tap movement command to go from state i to state j
3242 * 0: Test-Logic-Reset
3249 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
3256 } tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3258 /* value clocked to TMS to move from one of six stable states to another.
3259 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
3260 * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
3261 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
3262 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
3266 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
3267 * Read the bits from LSBit first to MSBit last (right-to-left).
3269 #define HEX__(n) 0x##n##LU
3272 (((x) & 0x0000000FLU)?(1<<0):0) \
3273 +(((x) & 0x000000F0LU)?(1<<1):0) \
3274 +(((x) & 0x00000F00LU)?(1<<2):0) \
3275 +(((x) & 0x0000F000LU)?(1<<3):0) \
3276 +(((x) & 0x000F0000LU)?(1<<4):0) \
3277 +(((x) & 0x00F00000LU)?(1<<5):0) \
3278 +(((x) & 0x0F000000LU)?(1<<6):0) \
3279 +(((x) & 0xF0000000LU)?(1<<7):0)
3281 #define B8(bits,count) { ((u8)B8__(HEX__(bits))), (count) }
3283 #if 1 && ((BUILD_FT2232_FTD2XX==1) || (BUILD_FT2232_LIBFTDI==1) || (BUILD_JLINK==1))
3284 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
3286 OK, I added Peter's version of the state table, and it works OK for
3287 me on MC1322x. I've recreated the jlink portion of patch with this
3288 new state table. His changes to my state table are pretty minor in
3289 terms of total transitions, but Peter feels that his version fixes
3290 some long-standing problems.
3293 I added the bit count into the table, reduced RESET column to 7 bits from 8.
3296 state specific comments:
3297 ------------------------
3298 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
3299 work better on ARM9 with ft2232 driver. (Dick)
3301 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3302 needed on ARM9 with ft2232 driver. (Dick)
3304 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3305 needed on ARM9 with ft2232 driver. (Dick)
3309 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3310 { B8(1111111,7), B8(0000000,7), B8(00101,5), B8(01010,5), B8(001101,6), B8(010110,6) }, /* RESET */
3311 { B8(1111111,7), B8(0000000,7), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
3312 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
3313 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
3314 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
3315 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
3317 #else /* this is the old table, converted from hex and with the bit_count set to 7 for each combo, like before */
3320 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3321 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3322 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
3323 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
3324 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
3325 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
3326 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* IRPAUSE */
3330 #if 0 /* keeping old hex stuff for awhile, for reference */
3331 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */
3332 { 0x7f, 0x00, 0x17, 0x0a, 0x1b, 0x16 }, /* RESET */
3333 { 0x7f, 0x00, 0x25, 0x05, 0x2b, 0x0b }, /* IDLE */
3334 { 0x7f, 0x31, 0x00, 0x01, 0x0f, 0x2f }, /* DRSHIFT */
3335 { 0x7f, 0x30, 0x20, 0x17, 0x1e, 0x2f }, /* DRPAUSE */
3336 { 0x7f, 0x31, 0x07, 0x17, 0x00, 0x01 }, /* IRSHIFT */
3337 { 0x7f, 0x30, 0x1c, 0x17, 0x20, 0x2f } /* IRPAUSE */
3342 int tap_get_tms_path( tap_state_t from, tap_state_t to )
3344 return tms_seqs[tap_move_ndx(from)][tap_move_ndx(to)].bits;
3348 int tap_get_tms_path_len( tap_state_t from, tap_state_t to )
3350 return tms_seqs[tap_move_ndx(from)][tap_move_ndx(to)].bit_count;
3354 bool tap_is_state_stable(tap_state_t astate)
3358 /* A switch() is used because it is symbol dependent
3359 (not value dependent like an array), and can also check bounds.
3378 tap_state_t tap_state_transition(tap_state_t cur_state, bool tms)
3380 tap_state_t new_state;
3382 /* A switch is used because it is symbol dependent and not value dependent
3383 like an array. Also it can check for out of range conditions.
3391 new_state = cur_state;
3396 new_state = TAP_DRSELECT;
3399 new_state = TAP_IRSELECT;
3403 new_state = TAP_DREXIT1;
3407 new_state = TAP_DRUPDATE;
3410 new_state = TAP_DREXIT2;
3413 new_state = TAP_RESET;
3417 new_state = TAP_IREXIT1;
3421 new_state = TAP_IRUPDATE;
3424 new_state = TAP_IREXIT2;
3427 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3440 new_state = TAP_IDLE;
3443 new_state = TAP_DRCAPTURE;
3448 new_state = TAP_DRSHIFT;
3452 new_state = TAP_DRPAUSE;
3455 new_state = TAP_IRCAPTURE;
3460 new_state = TAP_IRSHIFT;
3464 new_state = TAP_IRPAUSE;
3467 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3476 const char* tap_state_name(tap_state_t state)
3482 case TAP_RESET: ret = "RESET"; break;
3483 case TAP_IDLE: ret = "RUN/IDLE"; break;
3484 case TAP_DRSELECT: ret = "DRSELECT"; break;
3485 case TAP_DRCAPTURE: ret = "DRCAPTURE"; break;
3486 case TAP_DRSHIFT: ret = "DRSHIFT"; break;
3487 case TAP_DREXIT1: ret = "DREXIT1"; break;
3488 case TAP_DRPAUSE: ret = "DRPAUSE"; break;
3489 case TAP_DREXIT2: ret = "DREXIT2"; break;
3490 case TAP_DRUPDATE: ret = "DRUPDATE"; break;
3491 case TAP_IRSELECT: ret = "IRSELECT"; break;
3492 case TAP_IRCAPTURE: ret = "IRCAPTURE"; break;
3493 case TAP_IRSHIFT: ret = "IRSHIFT"; break;
3494 case TAP_IREXIT1: ret = "IREXIT1"; break;
3495 case TAP_IRPAUSE: ret = "IRPAUSE"; break;
3496 case TAP_IREXIT2: ret = "IREXIT2"; break;
3497 case TAP_IRUPDATE: ret = "IRUPDATE"; break;
3498 default: ret = "???";
3504 static tap_state_t tap_state_by_name( const char *name )
3508 for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
3509 /* be nice to the human */
3510 if( 0 == strcasecmp( name, tap_state_name(x) ) ){
3518 #ifdef _DEBUG_JTAG_IO_
3520 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3521 do { buf[len] = bit ? '1' : '0'; } while(0)
3522 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3523 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3524 tap_state_name(a), tap_state_name(b), astr, bstr)
3526 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
3527 unsigned tap_bits, tap_state_t next_state)
3529 const u8 *tms_buffer;
3530 const u8 *tdi_buffer;
3535 unsigned tap_out_bits;
3539 tap_state_t last_state;
3541 // set startstate (and possibly last, if tap_bits == 0)
3542 last_state = next_state;
3543 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
3545 tms_buffer = (const u8 *)tms_buf;
3546 tdi_buffer = (const u8 *)tdi_buf;
3548 tap_bytes = TAP_SCAN_BYTES(tap_bits);
3549 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
3552 for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
3554 for(cur_bit = 0; cur_bit < 8; cur_bit++)
3556 // make sure we do not run off the end of the buffers
3557 unsigned tap_bit = cur_byte * 8 + cur_bit;
3558 if (tap_bit == tap_bits)
3561 // check and save TMS bit
3562 tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
3563 JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
3565 // use TMS bit to find the next TAP state
3566 next_state = tap_state_transition(last_state, tap_bit);
3568 // check and store TDI bit
3569 tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
3570 JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
3572 // increment TAP bits
3575 // Only show TDO bits on state transitions, or
3576 // after some number of bits in the same state.
3577 if ((next_state == last_state) && (tap_out_bits < 32))
3580 // terminate strings and display state transition
3581 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3582 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3585 last_state = next_state;
3592 // terminate strings and display state transition
3593 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3594 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3597 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
3601 #endif // _DEBUG_JTAG_IO_
3603 #ifndef HAVE_JTAG_MINIDRIVER_H
3604 void jtag_alloc_in_value32(scan_field_t *field)
3606 field->in_value=(u8 *)cmd_queue_alloc(4);
3611 /*-----</Cable Helper API>--------------------------------------*/