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_comand_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_comand_pointer;
442 void* cmd_queue_alloc(size_t size)
444 cmd_queue_page_t **p_page = &cmd_queue_pages;
450 * We align/round the *SIZE* per below
451 * so that all pointers returned by
452 * this function are reasonably well
455 * If we did not, then an "odd-length" request would cause the
456 * *next* allocation to be at an *odd* address, and because
457 * this function has the same type of api as malloc() - we
458 * must also return pointers that have the same type of
461 * What I do not/have is a reasonable portable means
464 * The solution here, is based on these suggestions.
465 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
468 union worse_case_align {
474 #define ALIGN_SIZE (sizeof(union worse_case_align))
476 /* The alignment process. */
477 size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
482 while ((*p_page)->next)
483 p_page = &((*p_page)->next);
484 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
485 p_page = &((*p_page)->next);
490 *p_page = malloc(sizeof(cmd_queue_page_t));
492 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
493 (*p_page)->next = NULL;
496 offset = (*p_page)->used;
497 (*p_page)->used += size;
499 t=(u8 *)((*p_page)->address);
503 void cmd_queue_free(void)
505 cmd_queue_page_t *page = cmd_queue_pages;
509 cmd_queue_page_t *last = page;
515 cmd_queue_pages = NULL;
518 static void jtag_prelude1(void)
522 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
523 jtag_error=ERROR_JTAG_TRST_ASSERTED;
527 if (cmd_queue_end_state == TAP_RESET)
528 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
531 static void jtag_prelude(tap_state_t state)
535 if (state != TAP_INVALID)
536 jtag_add_end_state(state);
538 cmd_queue_cur_state = cmd_queue_end_state;
541 void jtag_add_ir_scan_noverify(int num_fields, scan_field_t *fields, tap_state_t state)
546 retval=interface_jtag_add_ir_scan(num_fields, fields, cmd_queue_end_state);
547 if (retval!=ERROR_OK)
553 void jtag_add_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
555 if (jtag_verify&&jtag_verify_capture_ir)
557 /* 8 x 32 bit id's is enough for all invoations */
559 for (j = 0; j < num_fields; j++)
561 fields[j].check_value=NULL;
562 fields[j].check_mask=NULL;
563 /* if we are to run a verification of the ir scan, we need to get the input back.
564 * We may have to allocate space if the caller didn't ask for the input back.
566 fields[j].check_value=fields[j].tap->expected;
567 fields[j].check_mask=fields[j].tap->expected_mask;
569 jtag_add_scan_check(jtag_add_ir_scan_noverify, num_fields, fields, state);
572 jtag_add_ir_scan_noverify(num_fields, fields, state);
576 int MINIDRIVER(interface_jtag_add_ir_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
578 jtag_command_t **last_cmd;
585 last_cmd = jtag_get_last_command_p();
587 /* allocate memory for a new list member */
588 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
589 (*last_cmd)->next = NULL;
590 last_comand_pointer = &((*last_cmd)->next);
591 (*last_cmd)->type = JTAG_SCAN;
593 /* allocate memory for ir scan command */
594 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
595 (*last_cmd)->cmd.scan->ir_scan = 1;
596 x = jtag_NumEnabledTaps();
597 (*last_cmd)->cmd.scan->num_fields = x; /* one field per device */
598 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(x * sizeof(scan_field_t));
599 (*last_cmd)->cmd.scan->end_state = state;
606 /* do this here so it is not forgotten */
607 tap = jtag_NextEnabledTap(tap);
613 assert(nth_tap < x );
615 scan_size = tap->ir_length;
616 (*last_cmd)->cmd.scan->fields[nth_tap].tap = tap;
617 (*last_cmd)->cmd.scan->fields[nth_tap].num_bits = scan_size;
618 (*last_cmd)->cmd.scan->fields[nth_tap].in_value = NULL; /* do not collect input for tap's in bypass */
620 /* search the list */
621 for (j = 0; j < num_fields; j++)
623 if (tap == fields[j].tap)
626 (*last_cmd)->cmd.scan->fields[nth_tap].in_value = fields[j].in_value;
627 (*last_cmd)->cmd.scan->fields[nth_tap].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
636 /* if a tap isn't listed, set it to BYPASS */
637 (*last_cmd)->cmd.scan->fields[nth_tap].out_value = buf_set_ones(cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
641 /* update device information */
642 buf_cpy((*last_cmd)->cmd.scan->fields[nth_tap].out_value, tap->cur_instr, scan_size);
644 assert(nth_tap == (x-1));
649 void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
655 retval=interface_jtag_add_plain_ir_scan(num_fields, fields, cmd_queue_end_state);
656 if (retval!=ERROR_OK)
660 int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
663 jtag_command_t **last_cmd;
665 last_cmd = jtag_get_last_command_p();
667 /* allocate memory for a new list member */
668 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
669 (*last_cmd)->next = NULL;
670 last_comand_pointer = &((*last_cmd)->next);
671 (*last_cmd)->type = JTAG_SCAN;
673 /* allocate memory for ir scan command */
674 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
675 (*last_cmd)->cmd.scan->ir_scan = 1;
676 (*last_cmd)->cmd.scan->num_fields = num_fields;
677 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
678 (*last_cmd)->cmd.scan->end_state = state;
680 for( i = 0 ; i < num_fields ; i++ ){
681 int num_bits = fields[i].num_bits;
682 int num_bytes = CEIL(fields[i].num_bits, 8);
683 (*last_cmd)->cmd.scan->fields[i].tap = fields[i].tap;
684 (*last_cmd)->cmd.scan->fields[i].num_bits = num_bits;
685 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
686 (*last_cmd)->cmd.scan->fields[i].in_value = fields[i].in_value;
691 void jtag_add_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
697 retval=interface_jtag_add_dr_scan(num_fields, fields, cmd_queue_end_state);
698 if (retval!=ERROR_OK)
703 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
705 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
707 return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
710 static void jtag_add_scan_check(void (*jtag_add_scan)(int num_fields, scan_field_t *fields, tap_state_t state),
711 int num_fields, scan_field_t *fields, tap_state_t state)
713 for (int i=0; i<num_fields; i++)
715 fields[i].allocated=0;
716 fields[i].modified=0;
717 if ((fields[i].check_value!=NULL)&&(fields[i].in_value==NULL))
719 fields[i].modified=1;
720 /* we need storage space... */
721 #ifdef HAVE_JTAG_MINIDRIVER_H
722 if (fields[i].num_bits<=32)
724 /* This is enough space and we're executing this synchronously */
725 fields[i].in_value=fields[i].intmp;
728 fields[i].in_value=(u8 *)malloc(CEIL(fields[i].num_bits, 8));
729 fields[i].allocated=1;
732 fields[i].in_value=(u8 *)cmd_queue_alloc(CEIL(fields[i].num_bits, 8));
737 jtag_add_scan(num_fields, fields, state);
739 for (int i=0; i<num_fields; i++)
741 if ((fields[i].check_value!=NULL)&&(fields[i].in_value!=NULL))
743 /* this is synchronous for a minidriver */
744 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);
746 if (fields[i].allocated)
748 free(fields[i].in_value);
750 if (fields[i].modified)
752 fields[i].in_value=NULL;
757 void jtag_add_dr_scan_check(int num_fields, scan_field_t *fields, tap_state_t state)
761 jtag_add_scan_check(jtag_add_dr_scan, num_fields, fields, state);
764 jtag_add_dr_scan(num_fields, fields, state);
768 int MINIDRIVER(interface_jtag_add_dr_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
772 int bypass_devices = 0;
776 jtag_command_t **last_cmd = jtag_get_last_command_p();
779 /* count devices in bypass */
783 tap = jtag_NextEnabledTap(tap);
792 /* allocate memory for a new list member */
793 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
794 last_comand_pointer = &((*last_cmd)->next);
795 (*last_cmd)->next = NULL;
796 (*last_cmd)->type = JTAG_SCAN;
798 /* allocate memory for dr scan command */
799 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
800 (*last_cmd)->cmd.scan->ir_scan = 0;
801 (*last_cmd)->cmd.scan->num_fields = num_fields + bypass_devices;
802 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
803 (*last_cmd)->cmd.scan->end_state = state;
809 tap = jtag_NextEnabledTap(tap);
814 (*last_cmd)->cmd.scan->fields[field_count].tap = tap;
816 for (j = 0; j < num_fields; j++)
818 if (tap == fields[j].tap)
821 scan_size = fields[j].num_bits;
822 (*last_cmd)->cmd.scan->fields[field_count].num_bits = scan_size;
823 (*last_cmd)->cmd.scan->fields[field_count].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
824 (*last_cmd)->cmd.scan->fields[field_count].in_value = fields[j].in_value;
830 #ifdef _DEBUG_JTAG_IO_
831 /* if a device isn't listed, the BYPASS register should be selected */
834 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
838 /* program the scan field to 1 bit length, and ignore it's value */
839 (*last_cmd)->cmd.scan->fields[field_count].num_bits = 1;
840 (*last_cmd)->cmd.scan->fields[field_count].out_value = NULL;
841 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
846 #ifdef _DEBUG_JTAG_IO_
847 /* if a device is listed, the BYPASS register must not be selected */
850 LOG_ERROR("BUG: scan data for a device in BYPASS");
859 void MINIDRIVER(interface_jtag_add_dr_out)(jtag_tap_t *target_tap,
863 tap_state_t end_state)
868 int bypass_devices = 0;
870 jtag_command_t **last_cmd = jtag_get_last_command_p();
873 /* count devices in bypass */
877 tap = jtag_NextEnabledTap(tap);
886 /* allocate memory for a new list member */
887 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
888 last_comand_pointer = &((*last_cmd)->next);
889 (*last_cmd)->next = NULL;
890 (*last_cmd)->type = JTAG_SCAN;
892 /* allocate memory for dr scan command */
893 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
894 (*last_cmd)->cmd.scan->ir_scan = 0;
895 (*last_cmd)->cmd.scan->num_fields = num_fields + bypass_devices;
896 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
897 (*last_cmd)->cmd.scan->end_state = end_state;
902 tap = jtag_NextEnabledTap(tap);
907 (*last_cmd)->cmd.scan->fields[field_count].tap = tap;
909 if (tap == target_tap)
912 #ifdef _DEBUG_JTAG_IO_
913 /* if a device is listed, the BYPASS register must not be selected */
916 LOG_ERROR("BUG: scan data for a device in BYPASS");
920 for (j = 0; j < num_fields; j++)
923 scan_size = num_bits[j];
924 buf_set_u32(out_value, 0, scan_size, value[j]);
925 (*last_cmd)->cmd.scan->fields[field_count].num_bits = scan_size;
926 (*last_cmd)->cmd.scan->fields[field_count].out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
927 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
932 #ifdef _DEBUG_JTAG_IO_
933 /* if a device isn't listed, the BYPASS register should be selected */
936 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
940 /* program the scan field to 1 bit length, and ignore it's value */
941 (*last_cmd)->cmd.scan->fields[field_count].num_bits = 1;
942 (*last_cmd)->cmd.scan->fields[field_count].out_value = NULL;
943 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
949 void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
955 retval=interface_jtag_add_plain_dr_scan(num_fields, fields, cmd_queue_end_state);
956 if (retval!=ERROR_OK)
960 int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
963 jtag_command_t **last_cmd = jtag_get_last_command_p();
965 /* allocate memory for a new list member */
966 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
967 last_comand_pointer = &((*last_cmd)->next);
968 (*last_cmd)->next = NULL;
969 (*last_cmd)->type = JTAG_SCAN;
971 /* allocate memory for scan command */
972 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
973 (*last_cmd)->cmd.scan->ir_scan = 0;
974 (*last_cmd)->cmd.scan->num_fields = num_fields;
975 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
976 (*last_cmd)->cmd.scan->end_state = state;
978 for (i = 0; i < num_fields; i++)
980 int num_bits = fields[i].num_bits;
981 int num_bytes = CEIL(fields[i].num_bits, 8);
982 (*last_cmd)->cmd.scan->fields[i].tap = fields[i].tap;
983 (*last_cmd)->cmd.scan->fields[i].num_bits = num_bits;
984 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
985 (*last_cmd)->cmd.scan->fields[i].in_value = fields[i].in_value;
991 void jtag_add_tlr(void)
993 jtag_prelude(TAP_RESET);
996 retval=interface_jtag_add_tlr();
997 if (retval!=ERROR_OK)
1001 int MINIDRIVER(interface_jtag_add_tlr)(void)
1003 tap_state_t state = TAP_RESET;
1004 jtag_command_t **last_cmd = jtag_get_last_command_p();
1006 /* allocate memory for a new list member */
1007 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1008 last_comand_pointer = &((*last_cmd)->next);
1009 (*last_cmd)->next = NULL;
1010 (*last_cmd)->type = JTAG_STATEMOVE;
1012 (*last_cmd)->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1013 (*last_cmd)->cmd.statemove->end_state = state;
1018 void jtag_add_pathmove(int num_states, tap_state_t *path)
1020 tap_state_t cur_state = cmd_queue_cur_state;
1024 /* the last state has to be a stable state */
1025 if (!tap_is_state_stable(path[num_states - 1]))
1027 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
1031 for (i=0; i<num_states; i++)
1033 if (path[i] == TAP_RESET)
1035 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
1039 if ( tap_state_transition(cur_state, true) != path[i]
1040 && tap_state_transition(cur_state, false) != path[i])
1042 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
1045 cur_state = path[i];
1050 retval = interface_jtag_add_pathmove(num_states, path);
1051 cmd_queue_cur_state = path[num_states - 1];
1052 if (retval!=ERROR_OK)
1056 int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, tap_state_t *path)
1058 jtag_command_t **last_cmd = jtag_get_last_command_p();
1061 /* allocate memory for a new list member */
1062 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1063 last_comand_pointer = &((*last_cmd)->next);
1064 (*last_cmd)->next = NULL;
1065 (*last_cmd)->type = JTAG_PATHMOVE;
1067 (*last_cmd)->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
1068 (*last_cmd)->cmd.pathmove->num_states = num_states;
1069 (*last_cmd)->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);
1071 for (i = 0; i < num_states; i++)
1072 (*last_cmd)->cmd.pathmove->path[i] = path[i];
1077 int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, tap_state_t state)
1079 jtag_command_t **last_cmd = jtag_get_last_command_p();
1081 /* allocate memory for a new list member */
1082 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1083 (*last_cmd)->next = NULL;
1084 last_comand_pointer = &((*last_cmd)->next);
1085 (*last_cmd)->type = JTAG_RUNTEST;
1087 (*last_cmd)->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
1088 (*last_cmd)->cmd.runtest->num_cycles = num_cycles;
1089 (*last_cmd)->cmd.runtest->end_state = state;
1094 void jtag_add_runtest(int num_cycles, tap_state_t state)
1098 jtag_prelude(state);
1100 /* executed by sw or hw fifo */
1101 retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
1102 if (retval!=ERROR_OK)
1107 int MINIDRIVER(interface_jtag_add_clocks)( int num_cycles )
1109 jtag_command_t **last_cmd = jtag_get_last_command_p();
1111 /* allocate memory for a new list member */
1112 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1113 (*last_cmd)->next = NULL;
1114 last_comand_pointer = &((*last_cmd)->next);
1115 (*last_cmd)->type = JTAG_STABLECLOCKS;
1117 (*last_cmd)->cmd.stableclocks = cmd_queue_alloc(sizeof(stableclocks_command_t));
1118 (*last_cmd)->cmd.stableclocks->num_cycles = num_cycles;
1122 void jtag_add_clocks( int num_cycles )
1126 if( !tap_is_state_stable(cmd_queue_cur_state) )
1128 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
1129 tap_state_name(cmd_queue_cur_state) );
1130 jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
1134 if( num_cycles > 0 )
1138 retval = interface_jtag_add_clocks(num_cycles);
1139 if (retval != ERROR_OK)
1144 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
1146 int trst_with_tlr = 0;
1149 /* FIX!!! there are *many* different cases here. A better
1150 * approach is needed for legal combinations of transitions...
1152 if ((jtag_reset_config & RESET_HAS_SRST)&&
1153 (jtag_reset_config & RESET_HAS_TRST)&&
1154 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
1156 if (((req_tlr_or_trst&&!jtag_trst)||
1157 (!req_tlr_or_trst&&jtag_trst))&&
1158 ((req_srst&&!jtag_srst)||
1159 (!req_srst&&jtag_srst)))
1161 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
1162 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
1166 /* Make sure that jtag_reset_config allows the requested reset */
1167 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
1168 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
1170 LOG_ERROR("BUG: requested reset would assert trst");
1171 jtag_error=ERROR_FAIL;
1175 /* if TRST pulls SRST, we reset with TAP T-L-R */
1176 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
1181 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
1183 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
1184 jtag_error=ERROR_FAIL;
1188 if (req_tlr_or_trst)
1190 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
1202 jtag_srst = req_srst;
1204 retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
1205 if (retval!=ERROR_OK)
1213 LOG_DEBUG("SRST line asserted");
1217 LOG_DEBUG("SRST line released");
1218 if (jtag_nsrst_delay)
1219 jtag_add_sleep(jtag_nsrst_delay * 1000);
1224 LOG_DEBUG("JTAG reset with RESET instead of TRST");
1225 jtag_add_end_state(TAP_RESET);
1227 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1233 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1234 * and inform possible listeners about this
1236 LOG_DEBUG("TRST line asserted");
1237 cmd_queue_cur_state = TAP_RESET;
1238 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1242 if (jtag_ntrst_delay)
1243 jtag_add_sleep(jtag_ntrst_delay * 1000);
1247 int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
1249 jtag_command_t **last_cmd = jtag_get_last_command_p();
1251 /* allocate memory for a new list member */
1252 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1253 (*last_cmd)->next = NULL;
1254 last_comand_pointer = &((*last_cmd)->next);
1255 (*last_cmd)->type = JTAG_RESET;
1257 (*last_cmd)->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
1258 (*last_cmd)->cmd.reset->trst = req_trst;
1259 (*last_cmd)->cmd.reset->srst = req_srst;
1264 void jtag_add_end_state(tap_state_t state)
1266 cmd_queue_end_state = state;
1267 if ((cmd_queue_end_state == TAP_DRSHIFT)||(cmd_queue_end_state == TAP_IRSHIFT))
1269 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
1273 int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
1275 jtag_command_t **last_cmd = jtag_get_last_command_p();
1277 /* allocate memory for a new list member */
1278 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1279 (*last_cmd)->next = NULL;
1280 last_comand_pointer = &((*last_cmd)->next);
1281 (*last_cmd)->type = JTAG_SLEEP;
1283 (*last_cmd)->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
1284 (*last_cmd)->cmd.sleep->us = us;
1289 void jtag_add_sleep(u32 us)
1291 keep_alive(); /* we might be running on a very slow JTAG clk */
1292 int retval=interface_jtag_add_sleep(us);
1293 if (retval!=ERROR_OK)
1298 int jtag_scan_size(scan_command_t *cmd)
1303 /* count bits in scan command */
1304 for (i = 0; i < cmd->num_fields; i++)
1306 bit_count += cmd->fields[i].num_bits;
1312 int jtag_build_buffer(scan_command_t *cmd, u8 **buffer)
1317 bit_count = jtag_scan_size(cmd);
1318 *buffer = malloc(CEIL(bit_count, 8));
1322 #ifdef _DEBUG_JTAG_IO_
1323 LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
1326 for (i = 0; i < cmd->num_fields; i++)
1328 if (cmd->fields[i].out_value)
1330 #ifdef _DEBUG_JTAG_IO_
1331 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);
1333 buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
1334 #ifdef _DEBUG_JTAG_IO_
1335 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
1341 #ifdef _DEBUG_JTAG_IO_
1342 LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
1346 bit_count += cmd->fields[i].num_bits;
1349 #ifdef _DEBUG_JTAG_IO_
1350 //LOG_DEBUG("bit_count totalling: %i", bit_count );
1356 int jtag_read_buffer(u8 *buffer, scan_command_t *cmd)
1362 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1365 for (i = 0; i < cmd->num_fields; i++)
1367 /* if neither in_value nor in_handler
1368 * are specified we don't have to examine this field
1370 if (cmd->fields[i].in_value)
1372 int num_bits = cmd->fields[i].num_bits;
1373 u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
1375 #ifdef _DEBUG_JTAG_IO_
1376 char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1377 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
1381 if (cmd->fields[i].in_value)
1383 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
1388 bit_count += cmd->fields[i].num_bits;
1394 static const char *jtag_tap_name(jtag_tap_t *tap)
1396 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
1399 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
1401 int retval = ERROR_OK;
1403 int compare_failed = 0;
1406 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
1408 compare_failed = buf_cmp(captured, in_check_value, num_bits);
1410 if (compare_failed){
1411 /* An error handler could have caught the failing check
1412 * only report a problem when there wasn't a handler, or if the handler
1413 * acknowledged the error
1416 LOG_WARNING("TAP %s:",
1417 jtag_tap_name(field->tap));
1421 char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1422 char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1426 char *in_check_mask_char;
1427 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1428 LOG_WARNING("value captured during scan didn't pass the requested check:");
1429 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1430 captured_char, in_check_value_char, in_check_mask_char);
1431 free(in_check_mask_char);
1435 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);
1438 free(captured_char);
1439 free(in_check_value_char);
1441 retval = ERROR_JTAG_QUEUE_FAILED;
1448 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
1450 assert(field->in_value != NULL);
1454 /* no checking to do */
1458 jtag_execute_queue_noclear();
1460 int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
1461 jtag_set_error(retval);
1466 enum scan_type jtag_scan_type(scan_command_t *cmd)
1471 for (i = 0; i < cmd->num_fields; i++)
1473 if (cmd->fields[i].in_value)
1475 if (cmd->fields[i].out_value)
1483 #ifndef HAVE_JTAG_MINIDRIVER_H
1484 /* add callback to end of queue */
1485 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)
1487 struct jtag_callback_entry *entry=cmd_queue_alloc(sizeof(struct jtag_callback_entry));
1490 entry->callback=callback;
1496 if (jtag_callback_queue_head==NULL)
1498 jtag_callback_queue_head=entry;
1499 jtag_callback_queue_tail=entry;
1502 jtag_callback_queue_tail->next=entry;
1503 jtag_callback_queue_tail=entry;
1508 static int jtag_convert_to_callback4(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
1510 ((jtag_callback1_t)data1)(in);
1514 void jtag_add_callback(jtag_callback1_t callback, u8 *in)
1516 jtag_add_callback4(jtag_convert_to_callback4, in, (jtag_callback_data_t)callback, 0, 0);
1520 #ifndef HAVE_JTAG_MINIDRIVER_H
1522 int interface_jtag_execute_queue(void)
1528 LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
1532 retval = jtag->execute_queue();
1534 if (retval == ERROR_OK)
1536 struct jtag_callback_entry *entry;
1537 for (entry=jtag_callback_queue_head; entry!=NULL; entry=entry->next)
1539 retval=entry->callback(entry->in, entry->data1, entry->data2, entry->data3);
1540 if (retval!=ERROR_OK)
1547 jtag_callback_queue_head = NULL;
1548 jtag_callback_queue_tail = NULL;
1550 jtag_command_queue = NULL;
1551 last_comand_pointer = &jtag_command_queue;
1557 void jtag_execute_queue_noclear(void)
1559 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
1560 * E.g. a JTAG over TCP/IP or USB....
1562 jtag_flush_queue_count++;
1564 int retval=interface_jtag_execute_queue();
1565 /* we keep the first error */
1566 if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
1572 int jtag_execute_queue(void)
1575 jtag_execute_queue_noclear();
1577 jtag_error=ERROR_OK;
1581 int jtag_reset_callback(enum jtag_event event, void *priv)
1583 jtag_tap_t *tap = priv;
1587 if (event == JTAG_TRST_ASSERTED)
1589 buf_set_ones(tap->cur_instr, tap->ir_length);
1596 void jtag_sleep(u32 us)
1598 alive_sleep(us/1000);
1601 /* Try to examine chain layout according to IEEE 1149.1 §12
1603 int jtag_examine_chain(void)
1607 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1610 int device_count = 0;
1611 u8 zero_check = 0x0;
1612 u8 one_check = 0xff;
1615 field.num_bits = sizeof(idcode_buffer) * 8;
1616 field.out_value = idcode_buffer;
1618 field.in_value = idcode_buffer;
1623 for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1625 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1628 jtag_add_plain_dr_scan(1, &field, TAP_RESET);
1629 jtag_execute_queue();
1631 for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1633 zero_check |= idcode_buffer[i];
1634 one_check &= idcode_buffer[i];
1637 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1638 if ((zero_check == 0x00) || (one_check == 0xff))
1640 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1641 return ERROR_JTAG_INIT_FAILED;
1644 /* point at the 1st tap */
1645 tap = jtag_NextEnabledTap(NULL);
1647 LOG_ERROR("JTAG: No taps enabled?");
1648 return ERROR_JTAG_INIT_FAILED;
1651 for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1653 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1654 if ((idcode & 1) == 0)
1656 /* LSB must not be 0, this indicates a device in bypass */
1657 LOG_WARNING("Tap/Device does not have IDCODE");
1668 /* some devices, such as AVR will output all 1's instead of TDI
1669 input value at end of chain. */
1670 if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1673 /* End of chain (invalid manufacturer ID)
1675 * The JTAG examine is the very first thing that happens
1677 * A single JTAG device requires only 64 bits to be read back correctly.
1679 * The code below adds a check that the rest of the data scanned (640 bits)
1680 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1682 * earlier and gives more helpful/explicit error messages.
1684 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1686 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1687 if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1689 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1697 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1698 manufacturer = EXTRACT_MFG(idcode);
1699 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1700 part = EXTRACT_PART(idcode);
1701 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1702 version = EXTRACT_VER(idcode);
1704 LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1705 ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1706 idcode, manufacturer, part, version);
1712 tap->idcode = idcode;
1714 if (tap->expected_ids_cnt > 0) {
1715 /* Loop over the expected identification codes and test for a match */
1717 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1718 if( tap->idcode == tap->expected_ids[ii] ){
1723 /* If none of the expected ids matched, log an error */
1724 if (ii == tap->expected_ids_cnt) {
1725 LOG_ERROR("JTAG tap: %s got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1728 EXTRACT_MFG( tap->idcode ),
1729 EXTRACT_PART( tap->idcode ),
1730 EXTRACT_VER( tap->idcode ) );
1731 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1732 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1735 tap->expected_ids_cnt,
1736 tap->expected_ids[ii],
1737 EXTRACT_MFG( tap->expected_ids[ii] ),
1738 EXTRACT_PART( tap->expected_ids[ii] ),
1739 EXTRACT_VER( tap->expected_ids[ii] ) );
1742 return ERROR_JTAG_INIT_FAILED;
1744 LOG_INFO("JTAG Tap/device matched");
1748 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1752 tap = jtag_NextEnabledTap(tap);
1757 /* see if number of discovered devices matches configuration */
1758 if (device_count != jtag_NumEnabledTaps())
1760 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1761 device_count, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1762 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1763 return ERROR_JTAG_INIT_FAILED;
1769 int jtag_validate_chain(void)
1772 int total_ir_length = 0;
1778 total_ir_length = 0;
1780 tap = jtag_NextEnabledTap(tap);
1784 total_ir_length += tap->ir_length;
1787 total_ir_length += 2;
1788 ir_test = malloc(CEIL(total_ir_length, 8));
1789 buf_set_ones(ir_test, total_ir_length);
1792 field.num_bits = total_ir_length;
1793 field.out_value = ir_test;
1794 field.in_value = ir_test;
1797 jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1798 jtag_execute_queue();
1804 tap = jtag_NextEnabledTap(tap);
1809 val = buf_get_u32(ir_test, chain_pos, 2);
1812 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1813 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);
1816 return ERROR_JTAG_INIT_FAILED;
1818 chain_pos += tap->ir_length;
1821 val = buf_get_u32(ir_test, chain_pos, 2);
1824 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1825 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);
1828 return ERROR_JTAG_INIT_FAILED;
1836 enum jtag_tap_cfg_param {
1840 static Jim_Nvp nvp_config_opts[] = {
1841 { .name = "-event", .value = JCFG_EVENT },
1843 { .name = NULL, .value = -1 }
1846 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1852 /* parse config or cget options */
1853 while (goi->argc > 0) {
1854 Jim_SetEmptyResult (goi->interp);
1856 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1858 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1864 if (goi->argc == 0) {
1865 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1869 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1871 Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1875 if (goi->isconfigure) {
1876 if (goi->argc != 1) {
1877 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1881 if (goi->argc != 0) {
1882 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1888 jtag_tap_event_action_t *jteap;
1890 jteap = tap->event_action;
1891 /* replace existing? */
1893 if (jteap->event == (enum jtag_tap_event)n->value) {
1896 jteap = jteap->next;
1899 if (goi->isconfigure) {
1900 if (jteap == NULL) {
1902 jteap = calloc(1, sizeof (*jteap));
1904 jteap->event = n->value;
1905 Jim_GetOpt_Obj( goi, &o);
1907 Jim_DecrRefCount(interp, jteap->body);
1909 jteap->body = Jim_DuplicateObj(goi->interp, o);
1910 Jim_IncrRefCount(jteap->body);
1912 /* add to head of event list */
1913 jteap->next = tap->event_action;
1914 tap->event_action = jteap;
1915 Jim_SetEmptyResult(goi->interp);
1918 if (jteap == NULL) {
1919 Jim_SetEmptyResult(goi->interp);
1921 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1928 } /* while (goi->argc) */
1933 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1943 const Jim_Nvp opts[] = {
1944 #define NTAP_OPT_IRLEN 0
1945 { .name = "-irlen" , .value = NTAP_OPT_IRLEN },
1946 #define NTAP_OPT_IRMASK 1
1947 { .name = "-irmask" , .value = NTAP_OPT_IRMASK },
1948 #define NTAP_OPT_IRCAPTURE 2
1949 { .name = "-ircapture" , .value = NTAP_OPT_IRCAPTURE },
1950 #define NTAP_OPT_ENABLED 3
1951 { .name = "-enable" , .value = NTAP_OPT_ENABLED },
1952 #define NTAP_OPT_DISABLED 4
1953 { .name = "-disable" , .value = NTAP_OPT_DISABLED },
1954 #define NTAP_OPT_EXPECTED_ID 5
1955 { .name = "-expected-id" , .value = NTAP_OPT_EXPECTED_ID },
1956 { .name = NULL , .value = -1 },
1959 pTap = malloc( sizeof(jtag_tap_t) );
1960 memset( pTap, 0, sizeof(*pTap) );
1962 Jim_SetResult_sprintf( goi->interp, "no memory");
1966 * we expect CHIP + TAP + OPTIONS
1968 if( goi->argc < 3 ){
1969 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
1972 Jim_GetOpt_String( goi, &cp, NULL );
1973 pTap->chip = strdup(cp);
1975 Jim_GetOpt_String( goi, &cp, NULL );
1976 pTap->tapname = strdup(cp);
1978 /* name + dot + name + null */
1979 x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
1981 sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
1982 pTap->dotted_name = cp;
1984 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1985 pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
1987 /* default is enabled */
1990 /* deal with options */
1991 #define NTREQ_IRLEN 1
1992 #define NTREQ_IRCAPTURE 2
1993 #define NTREQ_IRMASK 4
1995 /* clear them as we find them */
1996 reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
1999 e = Jim_GetOpt_Nvp( goi, opts, &n );
2001 Jim_GetOpt_NvpUnknown( goi, opts, 0 );
2004 LOG_DEBUG("Processing option: %s", n->name );
2006 case NTAP_OPT_ENABLED:
2009 case NTAP_OPT_DISABLED:
2012 case NTAP_OPT_EXPECTED_ID:
2014 u32 *new_expected_ids;
2016 e = Jim_GetOpt_Wide( goi, &w );
2018 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
2022 new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
2023 if (new_expected_ids == NULL) {
2024 Jim_SetResult_sprintf( goi->interp, "no memory");
2028 memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
2030 new_expected_ids[pTap->expected_ids_cnt] = w;
2032 free(pTap->expected_ids);
2033 pTap->expected_ids = new_expected_ids;
2034 pTap->expected_ids_cnt++;
2037 case NTAP_OPT_IRLEN:
2038 case NTAP_OPT_IRMASK:
2039 case NTAP_OPT_IRCAPTURE:
2040 e = Jim_GetOpt_Wide( goi, &w );
2042 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
2045 if( (w < 0) || (w > 0xffff) ){
2047 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
2048 n->name, (int)(w), (int)(w));
2052 case NTAP_OPT_IRLEN:
2053 pTap->ir_length = w;
2054 reqbits &= (~(NTREQ_IRLEN));
2056 case NTAP_OPT_IRMASK:
2057 pTap->ir_capture_mask = w;
2058 reqbits &= (~(NTREQ_IRMASK));
2060 case NTAP_OPT_IRCAPTURE:
2061 pTap->ir_capture_value = w;
2062 reqbits &= (~(NTREQ_IRCAPTURE));
2065 } /* switch(n->value) */
2066 } /* while( goi->argc ) */
2068 /* Did we get all the options? */
2071 Jim_SetResult_sprintf( goi->interp,
2072 "newtap: %s missing required parameters",
2074 /* TODO: Tell user what is missing :-( */
2075 /* no memory leaks pelase */
2076 free(((void *)(pTap->expected_ids)));
2077 free(((void *)(pTap->chip)));
2078 free(((void *)(pTap->tapname)));
2079 free(((void *)(pTap->dotted_name)));
2080 free(((void *)(pTap)));
2084 pTap->expected = malloc( pTap->ir_length );
2085 pTap->expected_mask = malloc( pTap->ir_length );
2086 pTap->cur_instr = malloc( pTap->ir_length );
2088 buf_set_u32( pTap->expected,
2091 pTap->ir_capture_value );
2092 buf_set_u32( pTap->expected_mask,
2095 pTap->ir_capture_mask );
2096 buf_set_ones( pTap->cur_instr,
2101 jtag_register_event_callback(jtag_reset_callback, pTap );
2103 ppTap = &(jtag_all_taps);
2104 while( (*ppTap) != NULL ){
2105 ppTap = &((*ppTap)->next_tap);
2109 static int n_taps = 0;
2110 pTap->abs_chain_position = n_taps++;
2112 LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
2113 (*ppTap)->dotted_name,
2114 (*ppTap)->abs_chain_position,
2115 (*ppTap)->ir_length,
2116 (*ppTap)->ir_capture_value,
2117 (*ppTap)->ir_capture_mask );
2122 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
2128 struct command_context_s *context;
2132 JTAG_CMD_INIT_RESET,
2135 JTAG_CMD_TAPDISABLE,
2136 JTAG_CMD_TAPISENABLED,
2141 const Jim_Nvp jtag_cmds[] = {
2142 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
2143 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
2144 { .name = "newtap" , .value = JTAG_CMD_NEWTAP },
2145 { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED },
2146 { .name = "tapenable" , .value = JTAG_CMD_TAPENABLE },
2147 { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE },
2148 { .name = "configure" , .value = JTAG_CMD_CONFIGURE },
2149 { .name = "cget" , .value = JTAG_CMD_CGET },
2151 { .name = NULL, .value = -1 },
2154 context = Jim_GetAssocData(interp, "context");
2155 /* go past the command */
2156 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
2158 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
2160 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
2163 Jim_SetEmptyResult( goi.interp );
2165 case JTAG_CMD_INTERFACE:
2166 /* return the name of the interface */
2167 /* TCL code might need to know the exact type... */
2168 /* FUTURE: we allow this as a means to "set" the interface. */
2169 if( goi.argc != 0 ){
2170 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2173 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
2175 case JTAG_CMD_INIT_RESET:
2176 if( goi.argc != 0 ){
2177 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2180 e = jtag_init_reset(context);
2181 if( e != ERROR_OK ){
2182 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
2186 case JTAG_CMD_NEWTAP:
2187 return jim_newtap_cmd( &goi );
2189 case JTAG_CMD_TAPISENABLED:
2190 case JTAG_CMD_TAPENABLE:
2191 case JTAG_CMD_TAPDISABLE:
2192 if( goi.argc != 1 ){
2193 Jim_SetResultString( goi.interp, "Too many parameters",-1 );
2199 t = jtag_TapByJimObj( goi.interp, goi.argv[0] );
2204 case JTAG_CMD_TAPISENABLED:
2207 case JTAG_CMD_TAPENABLE:
2208 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
2212 case JTAG_CMD_TAPDISABLE:
2213 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
2218 Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
2225 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
2232 Jim_GetOpt_Obj(&goi, &o);
2233 t = jtag_TapByJimObj( goi.interp, o );
2238 goi.isconfigure = 0;
2239 return jtag_tap_configure_cmd( &goi, t);
2243 case JTAG_CMD_CONFIGURE:
2245 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
2252 Jim_GetOpt_Obj(&goi, &o);
2253 t = jtag_TapByJimObj( goi.interp, o );
2258 goi.isconfigure = 1;
2259 return jtag_tap_configure_cmd( &goi, t);
2266 int jtag_register_commands(struct command_context_s *cmd_ctx)
2268 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
2270 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
2271 COMMAND_CONFIG, "try to configure interface");
2272 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
2273 COMMAND_ANY, "set jtag speed (if supported)");
2274 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
2275 COMMAND_ANY, "same as jtag_speed, except it takes maximum khz as arguments. 0 KHz = RTCK.");
2276 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
2277 COMMAND_CONFIG, "jtag_device <ir_length> <ir_expected> <ir_mask>");
2278 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
2280 "[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]");
2281 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
2282 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
2283 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
2284 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
2286 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
2287 COMMAND_EXEC, "print current scan chain configuration");
2289 register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
2290 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
2291 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
2292 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
2293 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
2294 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
2295 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
2296 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
2297 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
2298 register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
2300 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
2301 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
2302 register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
2303 COMMAND_ANY, "verify value capture <enable|disable>");
2307 int jtag_interface_init(struct command_context_s *cmd_ctx)
2312 if (!jtag_interface)
2314 /* nothing was previously specified by "interface" command */
2315 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
2316 return ERROR_JTAG_INVALID_INTERFACE;
2320 jtag_interface->khz(speed_khz, &jtag_speed);
2324 if (jtag_interface->init() != ERROR_OK)
2325 return ERROR_JTAG_INIT_FAILED;
2327 jtag = jtag_interface;
2331 static int jtag_init_inner(struct command_context_s *cmd_ctx)
2336 LOG_DEBUG("Init JTAG chain");
2338 tap = jtag_NextEnabledTap(NULL);
2340 LOG_ERROR("There are no enabled taps?");
2341 return ERROR_JTAG_INIT_FAILED;
2345 if ((retval=jtag_execute_queue())!=ERROR_OK)
2348 /* examine chain first, as this could discover the real chain layout */
2349 if (jtag_examine_chain() != ERROR_OK)
2351 LOG_ERROR("trying to validate configured JTAG chain anyway...");
2354 if (jtag_validate_chain() != ERROR_OK)
2356 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
2362 int jtag_init_reset(struct command_context_s *cmd_ctx)
2366 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2369 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
2371 /* Reset can happen after a power cycle.
2373 * Ideally we would only assert TRST or run RESET before the target reset.
2375 * However w/srst_pulls_trst, trst is asserted together with the target
2376 * reset whether we want it or not.
2378 * NB! Some targets have JTAG circuitry disabled until a
2379 * trst & srst has been asserted.
2381 * NB! here we assume nsrst/ntrst delay are sufficient!
2383 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
2386 jtag_add_reset(1, 0); /* RESET or TRST */
2387 if (jtag_reset_config & RESET_HAS_SRST)
2389 jtag_add_reset(1, 1);
2390 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
2391 jtag_add_reset(0, 1);
2393 jtag_add_reset(0, 0);
2394 if ((retval = jtag_execute_queue()) != ERROR_OK)
2397 /* Check that we can communication on the JTAG chain + eventually we want to
2398 * be able to perform enumeration only after OpenOCD has started
2399 * telnet and GDB server
2401 * That would allow users to more easily perform any magic they need to before
2404 return jtag_init_inner(cmd_ctx);
2407 int jtag_init(struct command_context_s *cmd_ctx)
2410 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2412 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
2416 return jtag_init_reset(cmd_ctx);
2419 static int default_khz(int khz, int *jtag_speed)
2421 LOG_ERROR("Translation from khz to jtag_speed not implemented");
2425 static int default_speed_div(int speed, int *khz)
2427 LOG_ERROR("Translation from jtag_speed to khz not implemented");
2431 static int default_power_dropout(int *dropout)
2433 *dropout=0; /* by default we can't detect power dropout */
2437 static int default_srst_asserted(int *srst_asserted)
2439 *srst_asserted=0; /* by default we can't detect srst asserted */
2443 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2448 /* check whether the interface is already configured */
2451 LOG_WARNING("Interface already configured, ignoring");
2455 /* interface name is a mandatory argument */
2456 if (argc < 1 || args[0][0] == '\0')
2458 return ERROR_COMMAND_SYNTAX_ERROR;
2461 for (i=0; jtag_interfaces[i]; i++)
2463 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
2465 if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
2470 jtag_interface = jtag_interfaces[i];
2472 if (jtag_interface->khz == NULL)
2474 jtag_interface->khz = default_khz;
2476 if (jtag_interface->speed_div == NULL)
2478 jtag_interface->speed_div = default_speed_div;
2480 if (jtag_interface->power_dropout == NULL)
2482 jtag_interface->power_dropout = default_power_dropout;
2484 if (jtag_interface->srst_asserted == NULL)
2486 jtag_interface->srst_asserted = default_srst_asserted;
2493 /* no valid interface was found (i.e. the configuration option,
2494 * didn't match one of the compiled-in interfaces
2496 LOG_ERROR("No valid jtag interface found (%s)", args[0]);
2497 LOG_ERROR("compiled-in jtag interfaces:");
2498 for (i = 0; jtag_interfaces[i]; i++)
2500 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
2503 return ERROR_JTAG_INVALID_INTERFACE;
2506 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2510 Jim_Obj *newargs[ 10 ];
2513 * argv[-1] = command
2514 * argv[ 0] = ir length
2515 * argv[ 1] = ir capture
2516 * argv[ 2] = ir mask
2517 * argv[ 3] = not actually used by anything but in the docs
2521 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2524 command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2525 command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2529 command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2530 command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2531 command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2532 command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
2534 newargs[0] = Jim_NewStringObj( interp, "jtag", -1 );
2535 newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
2536 sprintf( buf, "chip%d", jtag_NumTotalTaps() );
2537 newargs[2] = Jim_NewStringObj( interp, buf, -1 );
2538 sprintf( buf, "tap%d", jtag_NumTotalTaps() );
2539 newargs[3] = Jim_NewStringObj( interp, buf, -1 );
2540 newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 );
2541 newargs[5] = Jim_NewStringObj( interp, args[0], -1 );
2542 newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 );
2543 newargs[7] = Jim_NewStringObj( interp, args[1], -1 );
2544 newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 );
2545 newargs[9] = Jim_NewStringObj( interp, args[2], -1 );
2547 command_print( cmd_ctx, "NEW COMMAND:");
2548 sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
2549 Jim_GetString( newargs[0], NULL ),
2550 Jim_GetString( newargs[1], NULL ),
2551 Jim_GetString( newargs[2], NULL ),
2552 Jim_GetString( newargs[3], NULL ),
2553 Jim_GetString( newargs[4], NULL ),
2554 Jim_GetString( newargs[5], NULL ),
2555 Jim_GetString( newargs[6], NULL ),
2556 Jim_GetString( newargs[7], NULL ),
2557 Jim_GetString( newargs[8], NULL ),
2558 Jim_GetString( newargs[9], NULL ) );
2560 e = jim_jtag_command( interp, 10, newargs );
2562 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
2567 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2571 tap = jtag_all_taps;
2572 command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
2573 command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
2576 u32 expected, expected_mask, cur_instr, ii;
2577 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
2578 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
2579 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
2581 command_print(cmd_ctx,
2582 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2583 tap->abs_chain_position,
2585 tap->enabled ? 'Y' : 'n',
2587 (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
2593 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
2594 command_print(cmd_ctx, " | | | | 0x%08x | | | | ",
2595 tap->expected_ids[ii]);
2598 tap = tap->next_tap;
2604 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2607 return ERROR_COMMAND_SYNTAX_ERROR;
2611 if (strcmp(args[0], "none") == 0)
2612 jtag_reset_config = RESET_NONE;
2613 else if (strcmp(args[0], "trst_only") == 0)
2614 jtag_reset_config = RESET_HAS_TRST;
2615 else if (strcmp(args[0], "srst_only") == 0)
2616 jtag_reset_config = RESET_HAS_SRST;
2617 else if (strcmp(args[0], "trst_and_srst") == 0)
2618 jtag_reset_config = RESET_TRST_AND_SRST;
2621 LOG_ERROR("(1) invalid reset_config argument (%s), defaulting to none", args[0]);
2622 jtag_reset_config = RESET_NONE;
2623 return ERROR_INVALID_ARGUMENTS;
2629 if (strcmp(args[1], "separate") == 0)
2631 /* seperate reset lines - default */
2634 if (strcmp(args[1], "srst_pulls_trst") == 0)
2635 jtag_reset_config |= RESET_SRST_PULLS_TRST;
2636 else if (strcmp(args[1], "trst_pulls_srst") == 0)
2637 jtag_reset_config |= RESET_TRST_PULLS_SRST;
2638 else if (strcmp(args[1], "combined") == 0)
2639 jtag_reset_config |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2642 LOG_ERROR("(2) invalid reset_config argument (%s), defaulting to none", args[1]);
2643 jtag_reset_config = RESET_NONE;
2644 return ERROR_INVALID_ARGUMENTS;
2651 if (strcmp(args[2], "trst_open_drain") == 0)
2652 jtag_reset_config |= RESET_TRST_OPEN_DRAIN;
2653 else if (strcmp(args[2], "trst_push_pull") == 0)
2654 jtag_reset_config &= ~RESET_TRST_OPEN_DRAIN;
2657 LOG_ERROR("(3) invalid reset_config argument (%s) defaulting to none", args[2] );
2658 jtag_reset_config = RESET_NONE;
2659 return ERROR_INVALID_ARGUMENTS;
2665 if (strcmp(args[3], "srst_push_pull") == 0)
2666 jtag_reset_config |= RESET_SRST_PUSH_PULL;
2667 else if (strcmp(args[3], "srst_open_drain") == 0)
2668 jtag_reset_config &= ~RESET_SRST_PUSH_PULL;
2671 LOG_ERROR("(4) invalid reset_config argument (%s), defaulting to none", args[3]);
2672 jtag_reset_config = RESET_NONE;
2673 return ERROR_INVALID_ARGUMENTS;
2680 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2684 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2689 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
2695 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2699 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2704 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
2710 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2712 int retval=ERROR_OK;
2716 LOG_DEBUG("handle jtag speed");
2719 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2721 /* this command can be called during CONFIG,
2722 * in which case jtag isn't initialized */
2725 retval=jtag->speed(cur_speed);
2727 } else if (argc == 0)
2731 return ERROR_COMMAND_SYNTAX_ERROR;
2733 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2738 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2740 int retval=ERROR_OK;
2741 LOG_DEBUG("handle jtag khz");
2745 speed_khz = strtoul(args[0], NULL, 0);
2749 LOG_DEBUG("have interface set up");
2751 if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
2757 cur_speed = jtag_speed = speed_div1;
2759 retval=jtag->speed(cur_speed);
2768 return ERROR_COMMAND_SYNTAX_ERROR;
2773 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
2779 command_print(cmd_ctx, "RCLK - adaptive");
2782 command_print(cmd_ctx, "%d kHz", speed_khz);
2788 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2794 return ERROR_COMMAND_SYNTAX_ERROR;
2798 state = tap_state_by_name( args[0] );
2800 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2801 return ERROR_COMMAND_SYNTAX_ERROR;
2803 jtag_add_end_state(state);
2804 jtag_execute_queue();
2806 command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
2811 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2818 return ERROR_COMMAND_SYNTAX_ERROR;
2821 if (args[0][0] == '1')
2823 else if (args[0][0] == '0')
2827 return ERROR_COMMAND_SYNTAX_ERROR;
2830 if (args[1][0] == '1')
2832 else if (args[1][0] == '0')
2836 return ERROR_COMMAND_SYNTAX_ERROR;
2839 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2840 return ERROR_JTAG_INIT_FAILED;
2842 jtag_add_reset(trst, srst);
2843 jtag_execute_queue();
2848 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2852 return ERROR_COMMAND_SYNTAX_ERROR;
2855 jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
2856 jtag_execute_queue();
2862 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2865 scan_field_t *fields;
2867 tap_state_t endstate;
2869 if ((argc < 2) || (argc % 2))
2871 return ERROR_COMMAND_SYNTAX_ERROR;
2874 /* optional "-endstate" */
2876 /* at the end of the arguments. */
2878 endstate = TAP_INVALID;
2880 /* have at least one pair of numbers. */
2881 /* is last pair the magic text? */
2882 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2885 cpA = args[ argc-1 ];
2886 for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2887 cpS = tap_state_name( endstate );
2888 if( 0 == strcmp( cpA, cpS ) ){
2892 if( endstate >= TAP_NUM_STATES ){
2893 return ERROR_COMMAND_SYNTAX_ERROR;
2895 /* found - remove the last 2 args */
2901 int num_fields = argc / 2;
2903 fields = malloc(sizeof(scan_field_t) * num_fields);
2905 for (i = 0; i < num_fields; i++)
2907 tap = jtag_TapByString( args[i*2] );
2910 command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2913 int field_size = tap->ir_length;
2914 fields[i].tap = tap;
2915 fields[i].num_bits = field_size;
2916 fields[i].out_value = malloc(CEIL(field_size, 8));
2917 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2918 fields[i].in_value = NULL;
2921 jtag_add_ir_scan(num_fields, fields, TAP_INVALID);
2922 /* did we have an endstate? */
2923 if (endstate != TAP_INVALID)
2924 jtag_add_end_state(endstate);
2926 jtag_execute_queue();
2928 for (i = 0; i < num_fields; i++)
2929 free(fields[i].out_value);
2936 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2939 scan_field_t *fields;
2941 int field_count = 0;
2944 tap_state_t endstate;
2947 * args[2] = num_bits
2948 * args[3] = hex string
2949 * ... repeat num bits and hex string ...
2952 * args[N-2] = "-endstate"
2953 * args[N-1] = statename
2955 if ((argc < 4) || ((argc % 2)!=0))
2957 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2961 /* assume no endstate */
2962 endstate = TAP_INVALID;
2963 /* validate arguments as numbers */
2965 for (i = 2; i < argc; i+=2)
2970 e = Jim_GetLong(interp, args[i], &bits);
2971 /* If valid - try next arg */
2976 /* Not valid.. are we at the end? */
2977 if ( ((i+2) != argc) ){
2978 /* nope, then error */
2982 /* it could be: "-endstate FOO" */
2984 /* get arg as a string. */
2985 cp = Jim_GetString( args[i], NULL );
2986 /* is it the magic? */
2987 if( 0 == strcmp( "-endstate", cp ) ){
2988 /* is the statename valid? */
2989 cp = Jim_GetString( args[i+1], NULL );
2991 /* see if it is a valid state name */
2992 endstate = tap_state_by_name(cp);
2994 /* update the error message */
2995 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
2997 /* valid - so clear the error */
2999 /* and remove the last 2 args */
3004 /* Still an error? */
3006 return e; /* too bad */
3008 } /* validate args */
3010 tap = jtag_TapByJimObj( interp, args[1] );
3015 num_fields=(argc-2)/2;
3016 fields = malloc(sizeof(scan_field_t) * num_fields);
3017 for (i = 2; i < argc; i+=2)
3023 Jim_GetLong(interp, args[i], &bits);
3024 str = Jim_GetString(args[i+1], &len);
3026 fields[field_count].tap = tap;
3027 fields[field_count].num_bits = bits;
3028 fields[field_count].out_value = malloc(CEIL(bits, 8));
3029 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
3030 fields[field_count].in_value = fields[field_count].out_value;
3034 jtag_add_dr_scan(num_fields, fields, TAP_INVALID);
3035 /* did we get an end state? */
3036 if (endstate != TAP_INVALID)
3037 jtag_add_end_state(endstate);
3039 retval = jtag_execute_queue();
3040 if (retval != ERROR_OK)
3042 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
3047 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
3048 for (i = 2; i < argc; i+=2)
3053 Jim_GetLong(interp, args[i], &bits);
3054 str = buf_to_str(fields[field_count].in_value, bits, 16);
3055 free(fields[field_count].out_value);
3057 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
3062 Jim_SetResult(interp, list);
3070 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
3072 Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_flush_queue_count));
3078 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3082 if (strcmp(args[0], "enable") == 0)
3084 jtag_verify_capture_ir = 1;
3086 else if (strcmp(args[0], "disable") == 0)
3088 jtag_verify_capture_ir = 0;
3091 return ERROR_COMMAND_SYNTAX_ERROR;
3093 } else if (argc != 0)
3095 return ERROR_COMMAND_SYNTAX_ERROR;
3098 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
3103 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3107 if (strcmp(args[0], "enable") == 0)
3111 else if (strcmp(args[0], "disable") == 0)
3116 return ERROR_COMMAND_SYNTAX_ERROR;
3118 } else if (argc != 0)
3120 return ERROR_COMMAND_SYNTAX_ERROR;
3123 command_print(cmd_ctx, "verify jtag capture is %s", (jtag_verify) ? "enabled": "disabled");
3128 int jtag_power_dropout(int *dropout)
3130 return jtag->power_dropout(dropout);
3133 int jtag_srst_asserted(int *srst_asserted)
3135 return jtag->srst_asserted(srst_asserted);
3138 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
3140 jtag_tap_event_action_t * jteap;
3143 jteap = tap->event_action;
3147 if (jteap->event == e) {
3149 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
3152 Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
3153 Jim_GetString(jteap->body, NULL) );
3154 if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
3155 Jim_PrintErrorMessage(interp);
3159 jteap = jteap->next;
3163 LOG_DEBUG( "event %d %s - no action",
3165 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
3169 /*-----<Cable Helper API>---------------------------------------*/
3171 /* these Cable Helper API functions are all documented in the jtag.h header file,
3172 using a Doxygen format. And since Doxygen's configuration file "Doxyfile",
3173 is setup to prefer its docs in the header file, no documentation is here, for
3174 if it were, it would have to be doubly maintained.
3178 * @see tap_set_state() and tap_get_state() accessors.
3179 * Actual name is not important since accessors hide it.
3181 static tap_state_t state_follower = TAP_RESET;
3183 void tap_set_state_impl( tap_state_t new_state )
3185 /* this is the state we think the TAPs are in now, was cur_state */
3186 state_follower = new_state;
3189 tap_state_t tap_get_state()
3191 return state_follower;
3195 * @see tap_set_end_state() and tap_get_end_state() accessors.
3196 * Actual name is not important because accessors hide it.
3198 static tap_state_t end_state_follower = TAP_RESET;
3200 void tap_set_end_state( tap_state_t new_end_state )
3202 /* this is the state we think the TAPs will be in at completion of the
3203 current TAP operation, was end_state
3205 end_state_follower = new_end_state;
3208 tap_state_t tap_get_end_state()
3210 return end_state_follower;
3214 int tap_move_ndx( tap_state_t astate )
3216 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
3222 case TAP_RESET: ndx = 0; break;
3223 case TAP_DRSHIFT: ndx = 2; break;
3224 case TAP_DRPAUSE: ndx = 3; break;
3225 case TAP_IDLE: ndx = 1; break;
3226 case TAP_IRSHIFT: ndx = 4; break;
3227 case TAP_IRPAUSE: ndx = 5; break;
3229 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate) );
3237 /* tap_move[i][j]: tap movement command to go from state i to state j
3238 * 0: Test-Logic-Reset
3245 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
3252 } tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3254 /* value clocked to TMS to move from one of six stable states to another.
3255 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
3256 * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
3257 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
3258 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
3262 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
3263 * Read the bits from LSBit first to MSBit last (right-to-left).
3265 #define HEX__(n) 0x##n##LU
3268 (((x) & 0x0000000FLU)?(1<<0):0) \
3269 +(((x) & 0x000000F0LU)?(1<<1):0) \
3270 +(((x) & 0x00000F00LU)?(1<<2):0) \
3271 +(((x) & 0x0000F000LU)?(1<<3):0) \
3272 +(((x) & 0x000F0000LU)?(1<<4):0) \
3273 +(((x) & 0x00F00000LU)?(1<<5):0) \
3274 +(((x) & 0x0F000000LU)?(1<<6):0) \
3275 +(((x) & 0xF0000000LU)?(1<<7):0)
3277 #define B8(bits,count) { ((u8)B8__(HEX__(bits))), (count) }
3279 #if 0 && ((BUILD_FT2232_FTD2XX==1) || (BUILD_FT2232_LIBFTDI==1) || (BUILD_JLINK==1))
3280 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
3282 OK, I added Peter's version of the state table, and it works OK for
3283 me on MC1322x. I've recreated the jlink portion of patch with this
3284 new state table. His changes to my state table are pretty minor in
3285 terms of total transitions, but Peter feels that his version fixes
3286 some long-standing problems.
3289 I added the bit count into the table, reduced RESET column to 7 bits from 8.
3292 state specific comments:
3293 ------------------------
3294 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
3295 work better on ARM9 with ft2232 driver. (Dick)
3297 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3298 needed on ARM9 with ft2232 driver. (Dick)
3300 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3301 needed on ARM9 with ft2232 driver. (Dick)
3305 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3306 { B8(1111111,7), B8(0,1), B8(00101,5), B8(01010,5), B8(001101,6), B8(010110,6) }, /* RESET */
3307 { B8(1111111,7), B8(0,1), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
3308 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
3309 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
3310 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
3311 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
3313 #else /* this is the old table, converted from hex and with the bit_count set to 7 for each combo, like before */
3316 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3317 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3318 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
3319 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
3320 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
3321 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
3322 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0100000,7), B8(0101111,7) } /* IRPAUSE */
3326 #if 0 /* keeping old hex stuff for awhile, for reference */
3327 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */
3328 { 0x7f, 0x00, 0x17, 0x0a, 0x1b, 0x16 }, /* RESET */
3329 { 0x7f, 0x00, 0x25, 0x05, 0x2b, 0x0b }, /* IDLE */
3330 { 0x7f, 0x31, 0x00, 0x01, 0x0f, 0x2f }, /* DRSHIFT */
3331 { 0x7f, 0x30, 0x20, 0x17, 0x1e, 0x2f }, /* DRPAUSE */
3332 { 0x7f, 0x31, 0x07, 0x17, 0x00, 0x01 }, /* IRSHIFT */
3333 { 0x7f, 0x30, 0x1c, 0x17, 0x20, 0x2f } /* IRPAUSE */
3338 int tap_get_tms_path( tap_state_t from, tap_state_t to )
3340 return tms_seqs[tap_move_ndx(from)][tap_move_ndx(to)].bits;
3344 int tap_get_tms_path_len( tap_state_t from, tap_state_t to )
3346 return tms_seqs[tap_move_ndx(from)][tap_move_ndx(to)].bit_count;
3350 bool tap_is_state_stable(tap_state_t astate)
3354 /* A switch() is used because it is symbol dependent
3355 (not value dependent like an array), and can also check bounds.
3374 tap_state_t tap_state_transition(tap_state_t cur_state, bool tms)
3376 tap_state_t new_state;
3378 /* A switch is used because it is symbol dependent and not value dependent
3379 like an array. Also it can check for out of range conditions.
3387 new_state = cur_state;
3392 new_state = TAP_DRSELECT;
3395 new_state = TAP_IRSELECT;
3399 new_state = TAP_DREXIT1;
3403 new_state = TAP_DRUPDATE;
3406 new_state = TAP_DREXIT2;
3409 new_state = TAP_RESET;
3413 new_state = TAP_IREXIT1;
3417 new_state = TAP_IRUPDATE;
3420 new_state = TAP_IREXIT2;
3423 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3436 new_state = TAP_IDLE;
3439 new_state = TAP_DRCAPTURE;
3444 new_state = TAP_DRSHIFT;
3448 new_state = TAP_DRPAUSE;
3451 new_state = TAP_IRCAPTURE;
3456 new_state = TAP_IRSHIFT;
3460 new_state = TAP_IRPAUSE;
3463 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3472 const char* tap_state_name(tap_state_t state)
3478 case TAP_RESET: ret = "RESET"; break;
3479 case TAP_IDLE: ret = "RUN/IDLE"; break;
3480 case TAP_DRSELECT: ret = "DRSELECT"; break;
3481 case TAP_DRCAPTURE: ret = "DRCAPTURE"; break;
3482 case TAP_DRSHIFT: ret = "DRSHIFT"; break;
3483 case TAP_DREXIT1: ret = "DREXIT1"; break;
3484 case TAP_DRPAUSE: ret = "DRPAUSE"; break;
3485 case TAP_DREXIT2: ret = "DREXIT2"; break;
3486 case TAP_DRUPDATE: ret = "DRUPDATE"; break;
3487 case TAP_IRSELECT: ret = "IRSELECT"; break;
3488 case TAP_IRCAPTURE: ret = "IRCAPTURE"; break;
3489 case TAP_IRSHIFT: ret = "IRSHIFT"; break;
3490 case TAP_IREXIT1: ret = "IREXIT1"; break;
3491 case TAP_IRPAUSE: ret = "IRPAUSE"; break;
3492 case TAP_IREXIT2: ret = "IREXIT2"; break;
3493 case TAP_IRUPDATE: ret = "IRUPDATE"; break;
3494 default: ret = "???";
3500 static tap_state_t tap_state_by_name( const char *name )
3504 for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
3505 /* be nice to the human */
3506 if( 0 == strcasecmp( name, tap_state_name(x) ) ){
3514 #ifdef _DEBUG_JTAG_IO_
3516 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3517 do { buf[len] = bit ? '1' : '0'; } while(0)
3518 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3519 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3520 tap_state_name(a), tap_state_name(b), astr, bstr)
3522 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
3523 unsigned tap_bits, tap_state_t next_state)
3525 const u8 *tms_buffer;
3526 const u8 *tdi_buffer;
3531 unsigned tap_out_bits;
3535 tap_state_t last_state;
3537 // set startstate (and possibly last, if tap_bits == 0)
3538 last_state = next_state;
3539 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
3541 tms_buffer = (const u8 *)tms_buf;
3542 tdi_buffer = (const u8 *)tdi_buf;
3544 tap_bytes = TAP_SCAN_BYTES(tap_bits);
3545 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
3548 for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
3550 for(cur_bit = 0; cur_bit < 8; cur_bit++)
3552 // make sure we do not run off the end of the buffers
3553 unsigned tap_bit = cur_byte * 8 + cur_bit;
3554 if (tap_bit == tap_bits)
3557 // check and save TMS bit
3558 tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
3559 JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
3561 // use TMS bit to find the next TAP state
3562 next_state = tap_state_transition(last_state, tap_bit);
3564 // check and store TDI bit
3565 tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
3566 JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
3568 // increment TAP bits
3571 // Only show TDO bits on state transitions, or
3572 // after some number of bits in the same state.
3573 if ((next_state == last_state) && (tap_out_bits < 32))
3576 // terminate strings and display state transition
3577 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3578 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3581 last_state = next_state;
3588 // terminate strings and display state transition
3589 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3590 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3593 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
3597 #endif // _DEBUG_JTAG_IO_
3599 #ifndef HAVE_JTAG_MINIDRIVER_H
3600 void jtag_alloc_in_value32(scan_field_t *field)
3602 field->in_value=(u8 *)cmd_queue_alloc(4);
3607 /*-----</Cable Helper API>--------------------------------------*/