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;
101 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
102 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
103 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
105 /* maximum number of JTAG devices expected in the chain
107 #define JTAG_MAX_CHAIN_SIZE 20
109 /* callbacks to inform high-level handlers about JTAG state changes */
110 jtag_event_callback_t *jtag_event_callbacks;
113 static int speed_khz = 0;
114 /* flag if the kHz speed was defined */
115 static int hasKHz = 0;
117 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
120 #if BUILD_ECOSBOARD == 1
121 extern jtag_interface_t zy1000_interface;
124 #if BUILD_PARPORT == 1
125 extern jtag_interface_t parport_interface;
129 extern jtag_interface_t dummy_interface;
132 #if BUILD_FT2232_FTD2XX == 1
133 extern jtag_interface_t ft2232_interface;
136 #if BUILD_FT2232_LIBFTDI == 1
137 extern jtag_interface_t ft2232_interface;
140 #if BUILD_AMTJTAGACCEL == 1
141 extern jtag_interface_t amt_jtagaccel_interface;
144 #if BUILD_EP93XX == 1
145 extern jtag_interface_t ep93xx_interface;
148 #if BUILD_AT91RM9200 == 1
149 extern jtag_interface_t at91rm9200_interface;
152 #if BUILD_GW16012 == 1
153 extern jtag_interface_t gw16012_interface;
156 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
157 extern jtag_interface_t presto_interface;
160 #if BUILD_USBPROG == 1
161 extern jtag_interface_t usbprog_interface;
165 extern jtag_interface_t jlink_interface;
168 #if BUILD_VSLLINK == 1
169 extern jtag_interface_t vsllink_interface;
173 extern jtag_interface_t rlink_interface;
176 #if BUILD_ARMJTAGEW == 1
177 extern jtag_interface_t armjtagew_interface;
180 jtag_interface_t *jtag_interfaces[] = {
181 #if BUILD_ECOSBOARD == 1
184 #if BUILD_PARPORT == 1
190 #if BUILD_FT2232_FTD2XX == 1
193 #if BUILD_FT2232_LIBFTDI == 1
196 #if BUILD_AMTJTAGACCEL == 1
197 &amt_jtagaccel_interface,
199 #if BUILD_EP93XX == 1
202 #if BUILD_AT91RM9200 == 1
203 &at91rm9200_interface,
205 #if BUILD_GW16012 == 1
208 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
211 #if BUILD_USBPROG == 1
217 #if BUILD_VSLLINK == 1
223 #if BUILD_ARMJTAGEW == 1
224 &armjtagew_interface,
229 jtag_interface_t *jtag = NULL;
232 static jtag_interface_t *jtag_interface = NULL;
235 /* forward declarations */
236 //void jtag_add_pathmove(int num_states, tap_state_t *path);
237 //void jtag_add_runtest(int num_cycles, tap_state_t endstate);
238 //void jtag_add_end_state(tap_state_t endstate);
239 //void jtag_add_sleep(u32 us);
240 //int jtag_execute_queue(void);
241 static tap_state_t tap_state_by_name(const char *name);
244 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
245 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
246 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
247 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
248 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
249 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
250 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
252 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
254 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
255 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
256 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
257 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
258 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
259 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args);
261 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
263 jtag_tap_t *jtag_AllTaps(void)
265 return jtag_all_taps;
268 int jtag_NumTotalTaps(void)
282 int jtag_NumEnabledTaps(void)
298 jtag_tap_t *jtag_TapByString( const char *s )
306 if( 0 == strcmp( t->dotted_name, s ) ){
312 /* backup plan is by number */
314 /* ok - is "s" a number? */
316 n = strtol( s, &cp, 0 );
317 if( (s != cp) && (*cp == 0) ){
319 t = jtag_TapByAbsPosition(n);
325 jtag_tap_t * jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *o )
330 cp = Jim_GetString( o, NULL );
335 t = jtag_TapByString( cp );
338 Jim_SetResult_sprintf(interp,"Tap: %s is unknown", cp );
343 /* returns a pointer to the n-th device in the scan chain */
344 jtag_tap_t * jtag_TapByAbsPosition( int n )
352 while( t && (n > 0)) {
359 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
361 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
363 if (callback == NULL)
365 return ERROR_INVALID_ARGUMENTS;
370 while ((*callbacks_p)->next)
371 callbacks_p = &((*callbacks_p)->next);
372 callbacks_p = &((*callbacks_p)->next);
375 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
376 (*callbacks_p)->callback = callback;
377 (*callbacks_p)->priv = priv;
378 (*callbacks_p)->next = NULL;
383 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
385 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
387 if (callback == NULL)
389 return ERROR_INVALID_ARGUMENTS;
394 jtag_event_callback_t **next = &((*callbacks_p)->next);
395 if ((*callbacks_p)->callback == callback)
398 *callbacks_p = *next;
406 int jtag_call_event_callbacks(enum jtag_event event)
408 jtag_event_callback_t *callback = jtag_event_callbacks;
410 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
414 callback->callback(event, callback->priv);
415 callback = callback->next;
421 /* returns a pointer to the pointer of the last command in queue
422 * this may be a pointer to the root pointer (jtag_command_queue)
423 * or to the next member of the last but one command
425 jtag_command_t** jtag_get_last_command_p(void)
427 /* jtag_command_t *cmd = jtag_command_queue;
433 return &jtag_command_queue;
437 return last_comand_pointer;
440 void* cmd_queue_alloc(size_t size)
442 cmd_queue_page_t **p_page = &cmd_queue_pages;
448 * We align/round the *SIZE* per below
449 * so that all pointers returned by
450 * this function are reasonably well
453 * If we did not, then an "odd-length" request would cause the
454 * *next* allocation to be at an *odd* address, and because
455 * this function has the same type of api as malloc() - we
456 * must also return pointers that have the same type of
459 * What I do not/have is a reasonable portable means
462 * The solution here, is based on these suggestions.
463 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
466 union worse_case_align {
472 #define ALIGN_SIZE (sizeof(union worse_case_align))
474 /* The alignment process. */
475 size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
480 while ((*p_page)->next)
481 p_page = &((*p_page)->next);
482 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
483 p_page = &((*p_page)->next);
488 *p_page = malloc(sizeof(cmd_queue_page_t));
490 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
491 (*p_page)->next = NULL;
494 offset = (*p_page)->used;
495 (*p_page)->used += size;
497 t=(u8 *)((*p_page)->address);
501 void cmd_queue_free(void)
503 cmd_queue_page_t *page = cmd_queue_pages;
507 cmd_queue_page_t *last = page;
513 cmd_queue_pages = NULL;
516 static void jtag_prelude1(void)
520 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
521 jtag_error=ERROR_JTAG_TRST_ASSERTED;
525 if (cmd_queue_end_state == TAP_RESET)
526 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
529 static void jtag_prelude(tap_state_t state)
533 if (state != TAP_INVALID)
534 jtag_add_end_state(state);
536 cmd_queue_cur_state = cmd_queue_end_state;
539 void jtag_add_ir_scan_noverify(int num_fields, scan_field_t *fields, tap_state_t state)
544 retval=interface_jtag_add_ir_scan(num_fields, fields, cmd_queue_end_state);
545 if (retval!=ERROR_OK)
551 void jtag_add_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
553 /* 8 x 32 bit id's is enough for all invoations */
555 for (j = 0; j < num_fields; j++)
557 fields[j].check_value=NULL;
558 fields[j].check_mask=NULL;
559 /* if we are to run a verification of the ir scan, we need to get the input back.
560 * We may have to allocate space if the caller didn't ask for the input back.
562 if (jtag_verify_capture_ir)
564 fields[j].check_value=fields[j].tap->expected;
565 fields[j].check_mask=fields[j].tap->expected_mask;
569 jtag_add_scan_check(jtag_add_ir_scan_noverify, num_fields, fields, state);
572 int MINIDRIVER(interface_jtag_add_ir_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
574 jtag_command_t **last_cmd;
581 last_cmd = jtag_get_last_command_p();
583 /* allocate memory for a new list member */
584 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
585 (*last_cmd)->next = NULL;
586 last_comand_pointer = &((*last_cmd)->next);
587 (*last_cmd)->type = JTAG_SCAN;
589 /* allocate memory for ir scan command */
590 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
591 (*last_cmd)->cmd.scan->ir_scan = 1;
592 x = jtag_NumEnabledTaps();
593 (*last_cmd)->cmd.scan->num_fields = x; /* one field per device */
594 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(x * sizeof(scan_field_t));
595 (*last_cmd)->cmd.scan->end_state = state;
602 /* do this here so it is not forgotten */
603 tap = jtag_NextEnabledTap(tap);
609 assert(nth_tap < x );
611 scan_size = tap->ir_length;
612 (*last_cmd)->cmd.scan->fields[nth_tap].tap = tap;
613 (*last_cmd)->cmd.scan->fields[nth_tap].num_bits = scan_size;
614 (*last_cmd)->cmd.scan->fields[nth_tap].in_value = NULL; /* do not collect input for tap's in bypass */
616 /* search the list */
617 for (j = 0; j < num_fields; j++)
619 if (tap == fields[j].tap)
622 (*last_cmd)->cmd.scan->fields[nth_tap].in_value = fields[j].in_value;
623 (*last_cmd)->cmd.scan->fields[nth_tap].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
632 /* if a tap isn't listed, set it to BYPASS */
633 (*last_cmd)->cmd.scan->fields[nth_tap].out_value = buf_set_ones(cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
637 /* update device information */
638 buf_cpy((*last_cmd)->cmd.scan->fields[nth_tap].out_value, tap->cur_instr, scan_size);
640 assert(nth_tap == (x-1));
645 void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
651 retval=interface_jtag_add_plain_ir_scan(num_fields, fields, cmd_queue_end_state);
652 if (retval!=ERROR_OK)
656 int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
659 jtag_command_t **last_cmd;
661 last_cmd = jtag_get_last_command_p();
663 /* allocate memory for a new list member */
664 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
665 (*last_cmd)->next = NULL;
666 last_comand_pointer = &((*last_cmd)->next);
667 (*last_cmd)->type = JTAG_SCAN;
669 /* allocate memory for ir scan command */
670 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
671 (*last_cmd)->cmd.scan->ir_scan = 1;
672 (*last_cmd)->cmd.scan->num_fields = num_fields;
673 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
674 (*last_cmd)->cmd.scan->end_state = state;
676 for( i = 0 ; i < num_fields ; i++ ){
677 int num_bits = fields[i].num_bits;
678 int num_bytes = CEIL(fields[i].num_bits, 8);
679 (*last_cmd)->cmd.scan->fields[i].tap = fields[i].tap;
680 (*last_cmd)->cmd.scan->fields[i].num_bits = num_bits;
681 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
682 (*last_cmd)->cmd.scan->fields[i].in_value = fields[i].in_value;
687 void jtag_add_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
693 retval=interface_jtag_add_dr_scan(num_fields, fields, cmd_queue_end_state);
694 if (retval!=ERROR_OK)
699 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
701 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
703 return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
706 static void jtag_add_scan_check(void (*jtag_add_scan)(int num_fields, scan_field_t *fields, tap_state_t state),
707 int num_fields, scan_field_t *fields, tap_state_t state)
709 for (int i=0; i<num_fields; i++)
711 fields[i].allocated=0;
712 fields[i].modified=0;
713 if ((fields[i].check_value!=NULL)&&(fields[i].in_value==NULL))
715 fields[i].modified=1;
716 /* we need storage space... */
717 #ifdef HAVE_JTAG_MINIDRIVER_H
718 if (fields[i].num_bits<=32)
720 /* This is enough space and we're executing this synchronously */
721 fields[i].in_value=(u8 *)&fields[i].intmp;
724 fields[i].in_value=(u8 *)malloc(CEIL(fields[i].num_bits, 8));
725 fields[i].allocated=1;
728 fields[i].in_value=(u8 *)cmd_queue_alloc(CEIL(fields[i].num_bits, 8));
733 jtag_add_scan(num_fields, fields, state);
735 for (int i=0; i<num_fields; i++)
737 if ((fields[i].check_value!=NULL)&&(fields[i].in_value!=NULL))
739 /* this is synchronous for a minidriver */
740 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);
742 if (fields[i].allocated)
744 free(fields[i].in_value);
746 if (fields[i].modified)
748 fields[i].in_value=NULL;
753 void jtag_add_dr_scan_check(int num_fields, scan_field_t *fields, tap_state_t state)
755 jtag_add_scan_check(jtag_add_dr_scan, num_fields, fields, state);
761 int MINIDRIVER(interface_jtag_add_dr_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
765 int bypass_devices = 0;
769 jtag_command_t **last_cmd = jtag_get_last_command_p();
772 /* count devices in bypass */
776 tap = jtag_NextEnabledTap(tap);
785 /* allocate memory for a new list member */
786 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
787 last_comand_pointer = &((*last_cmd)->next);
788 (*last_cmd)->next = NULL;
789 (*last_cmd)->type = JTAG_SCAN;
791 /* allocate memory for dr scan command */
792 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
793 (*last_cmd)->cmd.scan->ir_scan = 0;
794 (*last_cmd)->cmd.scan->num_fields = num_fields + bypass_devices;
795 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
796 (*last_cmd)->cmd.scan->end_state = state;
802 tap = jtag_NextEnabledTap(tap);
807 (*last_cmd)->cmd.scan->fields[field_count].tap = tap;
809 for (j = 0; j < num_fields; j++)
811 if (tap == fields[j].tap)
814 scan_size = fields[j].num_bits;
815 (*last_cmd)->cmd.scan->fields[field_count].num_bits = scan_size;
816 (*last_cmd)->cmd.scan->fields[field_count].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
817 (*last_cmd)->cmd.scan->fields[field_count].in_value = fields[j].in_value;
823 #ifdef _DEBUG_JTAG_IO_
824 /* if a device isn't listed, the BYPASS register should be selected */
827 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
831 /* program the scan field to 1 bit length, and ignore it's value */
832 (*last_cmd)->cmd.scan->fields[field_count].num_bits = 1;
833 (*last_cmd)->cmd.scan->fields[field_count].out_value = NULL;
834 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
839 #ifdef _DEBUG_JTAG_IO_
840 /* if a device is listed, the BYPASS register must not be selected */
843 LOG_ERROR("BUG: scan data for a device in BYPASS");
852 void MINIDRIVER(interface_jtag_add_dr_out)(jtag_tap_t *target_tap,
856 tap_state_t end_state)
861 int bypass_devices = 0;
863 jtag_command_t **last_cmd = jtag_get_last_command_p();
866 /* count devices in bypass */
870 tap = jtag_NextEnabledTap(tap);
879 /* allocate memory for a new list member */
880 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
881 last_comand_pointer = &((*last_cmd)->next);
882 (*last_cmd)->next = NULL;
883 (*last_cmd)->type = JTAG_SCAN;
885 /* allocate memory for dr scan command */
886 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
887 (*last_cmd)->cmd.scan->ir_scan = 0;
888 (*last_cmd)->cmd.scan->num_fields = num_fields + bypass_devices;
889 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
890 (*last_cmd)->cmd.scan->end_state = end_state;
895 tap = jtag_NextEnabledTap(tap);
900 (*last_cmd)->cmd.scan->fields[field_count].tap = tap;
902 if (tap == target_tap)
905 #ifdef _DEBUG_JTAG_IO_
906 /* if a device is listed, the BYPASS register must not be selected */
909 LOG_ERROR("BUG: scan data for a device in BYPASS");
913 for (j = 0; j < num_fields; j++)
916 scan_size = num_bits[j];
917 buf_set_u32(out_value, 0, scan_size, value[j]);
918 (*last_cmd)->cmd.scan->fields[field_count].num_bits = scan_size;
919 (*last_cmd)->cmd.scan->fields[field_count].out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
920 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
925 #ifdef _DEBUG_JTAG_IO_
926 /* if a device isn't listed, the BYPASS register should be selected */
929 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
933 /* program the scan field to 1 bit length, and ignore it's value */
934 (*last_cmd)->cmd.scan->fields[field_count].num_bits = 1;
935 (*last_cmd)->cmd.scan->fields[field_count].out_value = NULL;
936 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
942 void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
948 retval=interface_jtag_add_plain_dr_scan(num_fields, fields, cmd_queue_end_state);
949 if (retval!=ERROR_OK)
953 int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
956 jtag_command_t **last_cmd = jtag_get_last_command_p();
958 /* allocate memory for a new list member */
959 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
960 last_comand_pointer = &((*last_cmd)->next);
961 (*last_cmd)->next = NULL;
962 (*last_cmd)->type = JTAG_SCAN;
964 /* allocate memory for scan command */
965 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
966 (*last_cmd)->cmd.scan->ir_scan = 0;
967 (*last_cmd)->cmd.scan->num_fields = num_fields;
968 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
969 (*last_cmd)->cmd.scan->end_state = state;
971 for (i = 0; i < num_fields; i++)
973 int num_bits = fields[i].num_bits;
974 int num_bytes = CEIL(fields[i].num_bits, 8);
975 (*last_cmd)->cmd.scan->fields[i].tap = fields[i].tap;
976 (*last_cmd)->cmd.scan->fields[i].num_bits = num_bits;
977 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
978 (*last_cmd)->cmd.scan->fields[i].in_value = fields[i].in_value;
984 void jtag_add_tlr(void)
986 jtag_prelude(TAP_RESET);
989 retval=interface_jtag_add_tlr();
990 if (retval!=ERROR_OK)
994 int MINIDRIVER(interface_jtag_add_tlr)(void)
996 tap_state_t state = TAP_RESET;
997 jtag_command_t **last_cmd = jtag_get_last_command_p();
999 /* allocate memory for a new list member */
1000 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1001 last_comand_pointer = &((*last_cmd)->next);
1002 (*last_cmd)->next = NULL;
1003 (*last_cmd)->type = JTAG_STATEMOVE;
1005 (*last_cmd)->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1006 (*last_cmd)->cmd.statemove->end_state = state;
1011 void jtag_add_pathmove(int num_states, tap_state_t *path)
1013 tap_state_t cur_state = cmd_queue_cur_state;
1017 /* the last state has to be a stable state */
1018 if (!tap_is_state_stable(path[num_states - 1]))
1020 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
1024 for (i=0; i<num_states; i++)
1026 if (path[i] == TAP_RESET)
1028 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
1032 if ( tap_state_transition(cur_state, true) != path[i]
1033 && tap_state_transition(cur_state, false) != path[i])
1035 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
1038 cur_state = path[i];
1043 retval = interface_jtag_add_pathmove(num_states, path);
1044 cmd_queue_cur_state = path[num_states - 1];
1045 if (retval!=ERROR_OK)
1049 int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, tap_state_t *path)
1051 jtag_command_t **last_cmd = jtag_get_last_command_p();
1054 /* allocate memory for a new list member */
1055 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1056 last_comand_pointer = &((*last_cmd)->next);
1057 (*last_cmd)->next = NULL;
1058 (*last_cmd)->type = JTAG_PATHMOVE;
1060 (*last_cmd)->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
1061 (*last_cmd)->cmd.pathmove->num_states = num_states;
1062 (*last_cmd)->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);
1064 for (i = 0; i < num_states; i++)
1065 (*last_cmd)->cmd.pathmove->path[i] = path[i];
1070 int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, tap_state_t state)
1072 jtag_command_t **last_cmd = jtag_get_last_command_p();
1074 /* allocate memory for a new list member */
1075 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1076 (*last_cmd)->next = NULL;
1077 last_comand_pointer = &((*last_cmd)->next);
1078 (*last_cmd)->type = JTAG_RUNTEST;
1080 (*last_cmd)->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
1081 (*last_cmd)->cmd.runtest->num_cycles = num_cycles;
1082 (*last_cmd)->cmd.runtest->end_state = state;
1087 void jtag_add_runtest(int num_cycles, tap_state_t state)
1091 jtag_prelude(state);
1093 /* executed by sw or hw fifo */
1094 retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
1095 if (retval!=ERROR_OK)
1100 int MINIDRIVER(interface_jtag_add_clocks)( int num_cycles )
1102 jtag_command_t **last_cmd = jtag_get_last_command_p();
1104 /* allocate memory for a new list member */
1105 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1106 (*last_cmd)->next = NULL;
1107 last_comand_pointer = &((*last_cmd)->next);
1108 (*last_cmd)->type = JTAG_STABLECLOCKS;
1110 (*last_cmd)->cmd.stableclocks = cmd_queue_alloc(sizeof(stableclocks_command_t));
1111 (*last_cmd)->cmd.stableclocks->num_cycles = num_cycles;
1115 void jtag_add_clocks( int num_cycles )
1119 if( !tap_is_state_stable(cmd_queue_cur_state) )
1121 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
1122 tap_state_name(cmd_queue_cur_state) );
1123 jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
1127 if( num_cycles > 0 )
1131 retval = interface_jtag_add_clocks(num_cycles);
1132 if (retval != ERROR_OK)
1137 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
1139 int trst_with_tlr = 0;
1142 /* FIX!!! there are *many* different cases here. A better
1143 * approach is needed for legal combinations of transitions...
1145 if ((jtag_reset_config & RESET_HAS_SRST)&&
1146 (jtag_reset_config & RESET_HAS_TRST)&&
1147 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
1149 if (((req_tlr_or_trst&&!jtag_trst)||
1150 (!req_tlr_or_trst&&jtag_trst))&&
1151 ((req_srst&&!jtag_srst)||
1152 (!req_srst&&jtag_srst)))
1154 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
1155 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
1159 /* Make sure that jtag_reset_config allows the requested reset */
1160 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
1161 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
1163 LOG_ERROR("BUG: requested reset would assert trst");
1164 jtag_error=ERROR_FAIL;
1168 /* if TRST pulls SRST, we reset with TAP T-L-R */
1169 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
1174 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
1176 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
1177 jtag_error=ERROR_FAIL;
1181 if (req_tlr_or_trst)
1183 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
1195 jtag_srst = req_srst;
1197 retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
1198 if (retval!=ERROR_OK)
1206 LOG_DEBUG("SRST line asserted");
1210 LOG_DEBUG("SRST line released");
1211 if (jtag_nsrst_delay)
1212 jtag_add_sleep(jtag_nsrst_delay * 1000);
1217 LOG_DEBUG("JTAG reset with RESET instead of TRST");
1218 jtag_add_end_state(TAP_RESET);
1220 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1226 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1227 * and inform possible listeners about this
1229 LOG_DEBUG("TRST line asserted");
1230 cmd_queue_cur_state = TAP_RESET;
1231 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1235 if (jtag_ntrst_delay)
1236 jtag_add_sleep(jtag_ntrst_delay * 1000);
1240 int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
1242 jtag_command_t **last_cmd = jtag_get_last_command_p();
1244 /* allocate memory for a new list member */
1245 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1246 (*last_cmd)->next = NULL;
1247 last_comand_pointer = &((*last_cmd)->next);
1248 (*last_cmd)->type = JTAG_RESET;
1250 (*last_cmd)->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
1251 (*last_cmd)->cmd.reset->trst = req_trst;
1252 (*last_cmd)->cmd.reset->srst = req_srst;
1257 void jtag_add_end_state(tap_state_t state)
1259 cmd_queue_end_state = state;
1260 if ((cmd_queue_end_state == TAP_DRSHIFT)||(cmd_queue_end_state == TAP_IRSHIFT))
1262 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
1266 int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
1268 jtag_command_t **last_cmd = jtag_get_last_command_p();
1270 /* allocate memory for a new list member */
1271 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1272 (*last_cmd)->next = NULL;
1273 last_comand_pointer = &((*last_cmd)->next);
1274 (*last_cmd)->type = JTAG_SLEEP;
1276 (*last_cmd)->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
1277 (*last_cmd)->cmd.sleep->us = us;
1282 void jtag_add_sleep(u32 us)
1284 keep_alive(); /* we might be running on a very slow JTAG clk */
1285 int retval=interface_jtag_add_sleep(us);
1286 if (retval!=ERROR_OK)
1291 int jtag_scan_size(scan_command_t *cmd)
1296 /* count bits in scan command */
1297 for (i = 0; i < cmd->num_fields; i++)
1299 bit_count += cmd->fields[i].num_bits;
1305 int jtag_build_buffer(scan_command_t *cmd, u8 **buffer)
1310 bit_count = jtag_scan_size(cmd);
1311 *buffer = malloc(CEIL(bit_count, 8));
1315 #ifdef _DEBUG_JTAG_IO_
1316 LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
1319 for (i = 0; i < cmd->num_fields; i++)
1321 if (cmd->fields[i].out_value)
1323 #ifdef _DEBUG_JTAG_IO_
1324 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);
1326 buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
1327 #ifdef _DEBUG_JTAG_IO_
1328 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
1334 #ifdef _DEBUG_JTAG_IO_
1335 LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
1339 bit_count += cmd->fields[i].num_bits;
1342 #ifdef _DEBUG_JTAG_IO_
1343 //LOG_DEBUG("bit_count totalling: %i", bit_count );
1349 int jtag_read_buffer(u8 *buffer, scan_command_t *cmd)
1355 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1358 for (i = 0; i < cmd->num_fields; i++)
1360 /* if neither in_value nor in_handler
1361 * are specified we don't have to examine this field
1363 if (cmd->fields[i].in_value)
1365 int num_bits = cmd->fields[i].num_bits;
1366 u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
1368 #ifdef _DEBUG_JTAG_IO_
1369 char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1370 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
1374 if (cmd->fields[i].in_value)
1376 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
1381 bit_count += cmd->fields[i].num_bits;
1387 static const char *jtag_tap_name(jtag_tap_t *tap)
1389 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
1392 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
1394 int retval = ERROR_OK;
1396 int compare_failed = 0;
1399 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
1401 compare_failed = buf_cmp(captured, in_check_value, num_bits);
1403 if (compare_failed){
1404 /* An error handler could have caught the failing check
1405 * only report a problem when there wasn't a handler, or if the handler
1406 * acknowledged the error
1409 LOG_WARNING("TAP %s:",
1410 jtag_tap_name(field->tap));
1414 char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1415 char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1419 char *in_check_mask_char;
1420 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1421 LOG_WARNING("value captured during scan didn't pass the requested check:");
1422 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1423 captured_char, in_check_value_char, in_check_mask_char);
1424 free(in_check_mask_char);
1428 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);
1431 free(captured_char);
1432 free(in_check_value_char);
1434 retval = ERROR_JTAG_QUEUE_FAILED;
1441 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
1443 assert(field->in_value != NULL);
1447 /* no checking to do */
1451 jtag_execute_queue_noclear();
1453 int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
1454 jtag_set_error(retval);
1459 enum scan_type jtag_scan_type(scan_command_t *cmd)
1464 for (i = 0; i < cmd->num_fields; i++)
1466 if (cmd->fields[i].in_value)
1468 if (cmd->fields[i].out_value)
1476 #ifndef HAVE_JTAG_MINIDRIVER_H
1477 /* add callback to end of queue */
1478 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)
1480 struct jtag_callback_entry *entry=cmd_queue_alloc(sizeof(struct jtag_callback_entry));
1483 entry->callback=callback;
1489 if (jtag_callback_queue_head==NULL)
1491 jtag_callback_queue_head=entry;
1492 jtag_callback_queue_tail=entry;
1495 jtag_callback_queue_tail->next=entry;
1496 jtag_callback_queue_tail=entry;
1501 static int jtag_convert_to_callback4(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
1503 ((jtag_callback1_t)data1)(in);
1507 void jtag_add_callback(jtag_callback1_t callback, u8 *in)
1509 jtag_add_callback4(jtag_convert_to_callback4, in, (jtag_callback_data_t)callback, 0, 0);
1513 #ifndef HAVE_JTAG_MINIDRIVER_H
1515 int interface_jtag_execute_queue(void)
1521 LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
1525 retval = jtag->execute_queue();
1527 if (retval == ERROR_OK)
1529 struct jtag_callback_entry *entry;
1530 for (entry=jtag_callback_queue_head; entry!=NULL; entry=entry->next)
1532 retval=entry->callback(entry->in, entry->data1, entry->data2, entry->data3);
1533 if (retval!=ERROR_OK)
1540 jtag_callback_queue_head = NULL;
1541 jtag_callback_queue_tail = NULL;
1543 jtag_command_queue = NULL;
1544 last_comand_pointer = &jtag_command_queue;
1550 void jtag_execute_queue_noclear(void)
1552 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
1553 * E.g. a JTAG over TCP/IP or USB....
1555 jtag_flush_queue_count++;
1557 int retval=interface_jtag_execute_queue();
1558 /* we keep the first error */
1559 if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
1565 int jtag_execute_queue(void)
1568 jtag_execute_queue_noclear();
1570 jtag_error=ERROR_OK;
1574 int jtag_reset_callback(enum jtag_event event, void *priv)
1576 jtag_tap_t *tap = priv;
1580 if (event == JTAG_TRST_ASSERTED)
1582 buf_set_ones(tap->cur_instr, tap->ir_length);
1589 void jtag_sleep(u32 us)
1591 alive_sleep(us/1000);
1594 /* Try to examine chain layout according to IEEE 1149.1 §12
1596 int jtag_examine_chain(void)
1600 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1603 int device_count = 0;
1604 u8 zero_check = 0x0;
1605 u8 one_check = 0xff;
1608 field.num_bits = sizeof(idcode_buffer) * 8;
1609 field.out_value = idcode_buffer;
1611 field.in_value = idcode_buffer;
1616 for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1618 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1621 jtag_add_plain_dr_scan(1, &field, TAP_RESET);
1622 jtag_execute_queue();
1624 for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1626 zero_check |= idcode_buffer[i];
1627 one_check &= idcode_buffer[i];
1630 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1631 if ((zero_check == 0x00) || (one_check == 0xff))
1633 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1634 return ERROR_JTAG_INIT_FAILED;
1637 /* point at the 1st tap */
1638 tap = jtag_NextEnabledTap(NULL);
1640 LOG_ERROR("JTAG: No taps enabled?");
1641 return ERROR_JTAG_INIT_FAILED;
1644 for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1646 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1647 if ((idcode & 1) == 0)
1649 /* LSB must not be 0, this indicates a device in bypass */
1650 LOG_WARNING("Tap/Device does not have IDCODE");
1661 /* some devices, such as AVR will output all 1's instead of TDI
1662 input value at end of chain. */
1663 if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1666 /* End of chain (invalid manufacturer ID)
1668 * The JTAG examine is the very first thing that happens
1670 * A single JTAG device requires only 64 bits to be read back correctly.
1672 * The code below adds a check that the rest of the data scanned (640 bits)
1673 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1675 * earlier and gives more helpful/explicit error messages.
1677 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1679 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1680 if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1682 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1690 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1691 manufacturer = EXTRACT_MFG(idcode);
1692 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1693 part = EXTRACT_PART(idcode);
1694 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1695 version = EXTRACT_VER(idcode);
1697 LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1698 ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1699 idcode, manufacturer, part, version);
1705 tap->idcode = idcode;
1707 if (tap->expected_ids_cnt > 0) {
1708 /* Loop over the expected identification codes and test for a match */
1710 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1711 if( tap->idcode == tap->expected_ids[ii] ){
1716 /* If none of the expected ids matched, log an error */
1717 if (ii == tap->expected_ids_cnt) {
1718 LOG_ERROR("JTAG tap: %s got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1721 EXTRACT_MFG( tap->idcode ),
1722 EXTRACT_PART( tap->idcode ),
1723 EXTRACT_VER( tap->idcode ) );
1724 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1725 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1728 tap->expected_ids_cnt,
1729 tap->expected_ids[ii],
1730 EXTRACT_MFG( tap->expected_ids[ii] ),
1731 EXTRACT_PART( tap->expected_ids[ii] ),
1732 EXTRACT_VER( tap->expected_ids[ii] ) );
1735 return ERROR_JTAG_INIT_FAILED;
1737 LOG_INFO("JTAG Tap/device matched");
1741 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1745 tap = jtag_NextEnabledTap(tap);
1750 /* see if number of discovered devices matches configuration */
1751 if (device_count != jtag_NumEnabledTaps())
1753 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1754 device_count, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1755 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1756 return ERROR_JTAG_INIT_FAILED;
1762 int jtag_validate_chain(void)
1765 int total_ir_length = 0;
1771 total_ir_length = 0;
1773 tap = jtag_NextEnabledTap(tap);
1777 total_ir_length += tap->ir_length;
1780 total_ir_length += 2;
1781 ir_test = malloc(CEIL(total_ir_length, 8));
1782 buf_set_ones(ir_test, total_ir_length);
1785 field.num_bits = total_ir_length;
1786 field.out_value = ir_test;
1787 field.in_value = ir_test;
1790 jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1791 jtag_execute_queue();
1797 tap = jtag_NextEnabledTap(tap);
1802 val = buf_get_u32(ir_test, chain_pos, 2);
1805 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1806 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);
1809 return ERROR_JTAG_INIT_FAILED;
1811 chain_pos += tap->ir_length;
1814 val = buf_get_u32(ir_test, chain_pos, 2);
1817 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1818 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);
1821 return ERROR_JTAG_INIT_FAILED;
1829 enum jtag_tap_cfg_param {
1833 static Jim_Nvp nvp_config_opts[] = {
1834 { .name = "-event", .value = JCFG_EVENT },
1836 { .name = NULL, .value = -1 }
1839 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1845 /* parse config or cget options */
1846 while (goi->argc > 0) {
1847 Jim_SetEmptyResult (goi->interp);
1849 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1851 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1857 if (goi->argc == 0) {
1858 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1862 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1864 Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1868 if (goi->isconfigure) {
1869 if (goi->argc != 1) {
1870 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1874 if (goi->argc != 0) {
1875 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1881 jtag_tap_event_action_t *jteap;
1883 jteap = tap->event_action;
1884 /* replace existing? */
1886 if (jteap->event == (enum jtag_tap_event)n->value) {
1889 jteap = jteap->next;
1892 if (goi->isconfigure) {
1893 if (jteap == NULL) {
1895 jteap = calloc(1, sizeof (*jteap));
1897 jteap->event = n->value;
1898 Jim_GetOpt_Obj( goi, &o);
1900 Jim_DecrRefCount(interp, jteap->body);
1902 jteap->body = Jim_DuplicateObj(goi->interp, o);
1903 Jim_IncrRefCount(jteap->body);
1905 /* add to head of event list */
1906 jteap->next = tap->event_action;
1907 tap->event_action = jteap;
1908 Jim_SetEmptyResult(goi->interp);
1911 if (jteap == NULL) {
1912 Jim_SetEmptyResult(goi->interp);
1914 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1921 } /* while (goi->argc) */
1926 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1936 const Jim_Nvp opts[] = {
1937 #define NTAP_OPT_IRLEN 0
1938 { .name = "-irlen" , .value = NTAP_OPT_IRLEN },
1939 #define NTAP_OPT_IRMASK 1
1940 { .name = "-irmask" , .value = NTAP_OPT_IRMASK },
1941 #define NTAP_OPT_IRCAPTURE 2
1942 { .name = "-ircapture" , .value = NTAP_OPT_IRCAPTURE },
1943 #define NTAP_OPT_ENABLED 3
1944 { .name = "-enable" , .value = NTAP_OPT_ENABLED },
1945 #define NTAP_OPT_DISABLED 4
1946 { .name = "-disable" , .value = NTAP_OPT_DISABLED },
1947 #define NTAP_OPT_EXPECTED_ID 5
1948 { .name = "-expected-id" , .value = NTAP_OPT_EXPECTED_ID },
1949 { .name = NULL , .value = -1 },
1952 pTap = malloc( sizeof(jtag_tap_t) );
1953 memset( pTap, 0, sizeof(*pTap) );
1955 Jim_SetResult_sprintf( goi->interp, "no memory");
1959 * we expect CHIP + TAP + OPTIONS
1961 if( goi->argc < 3 ){
1962 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
1965 Jim_GetOpt_String( goi, &cp, NULL );
1966 pTap->chip = strdup(cp);
1968 Jim_GetOpt_String( goi, &cp, NULL );
1969 pTap->tapname = strdup(cp);
1971 /* name + dot + name + null */
1972 x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
1974 sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
1975 pTap->dotted_name = cp;
1977 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1978 pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
1980 /* default is enabled */
1983 /* deal with options */
1984 #define NTREQ_IRLEN 1
1985 #define NTREQ_IRCAPTURE 2
1986 #define NTREQ_IRMASK 4
1988 /* clear them as we find them */
1989 reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
1992 e = Jim_GetOpt_Nvp( goi, opts, &n );
1994 Jim_GetOpt_NvpUnknown( goi, opts, 0 );
1997 LOG_DEBUG("Processing option: %s", n->name );
1999 case NTAP_OPT_ENABLED:
2002 case NTAP_OPT_DISABLED:
2005 case NTAP_OPT_EXPECTED_ID:
2007 u32 *new_expected_ids;
2009 e = Jim_GetOpt_Wide( goi, &w );
2011 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
2015 new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
2016 if (new_expected_ids == NULL) {
2017 Jim_SetResult_sprintf( goi->interp, "no memory");
2021 memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
2023 new_expected_ids[pTap->expected_ids_cnt] = w;
2025 free(pTap->expected_ids);
2026 pTap->expected_ids = new_expected_ids;
2027 pTap->expected_ids_cnt++;
2030 case NTAP_OPT_IRLEN:
2031 case NTAP_OPT_IRMASK:
2032 case NTAP_OPT_IRCAPTURE:
2033 e = Jim_GetOpt_Wide( goi, &w );
2035 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
2038 if( (w < 0) || (w > 0xffff) ){
2040 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
2041 n->name, (int)(w), (int)(w));
2045 case NTAP_OPT_IRLEN:
2046 pTap->ir_length = w;
2047 reqbits &= (~(NTREQ_IRLEN));
2049 case NTAP_OPT_IRMASK:
2050 pTap->ir_capture_mask = w;
2051 reqbits &= (~(NTREQ_IRMASK));
2053 case NTAP_OPT_IRCAPTURE:
2054 pTap->ir_capture_value = w;
2055 reqbits &= (~(NTREQ_IRCAPTURE));
2058 } /* switch(n->value) */
2059 } /* while( goi->argc ) */
2061 /* Did we get all the options? */
2064 Jim_SetResult_sprintf( goi->interp,
2065 "newtap: %s missing required parameters",
2067 /* TODO: Tell user what is missing :-( */
2068 /* no memory leaks pelase */
2069 free(((void *)(pTap->expected_ids)));
2070 free(((void *)(pTap->chip)));
2071 free(((void *)(pTap->tapname)));
2072 free(((void *)(pTap->dotted_name)));
2073 free(((void *)(pTap)));
2077 pTap->expected = malloc( pTap->ir_length );
2078 pTap->expected_mask = malloc( pTap->ir_length );
2079 pTap->cur_instr = malloc( pTap->ir_length );
2081 buf_set_u32( pTap->expected,
2084 pTap->ir_capture_value );
2085 buf_set_u32( pTap->expected_mask,
2088 pTap->ir_capture_mask );
2089 buf_set_ones( pTap->cur_instr,
2094 jtag_register_event_callback(jtag_reset_callback, pTap );
2096 ppTap = &(jtag_all_taps);
2097 while( (*ppTap) != NULL ){
2098 ppTap = &((*ppTap)->next_tap);
2102 static int n_taps = 0;
2103 pTap->abs_chain_position = n_taps++;
2105 LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
2106 (*ppTap)->dotted_name,
2107 (*ppTap)->abs_chain_position,
2108 (*ppTap)->ir_length,
2109 (*ppTap)->ir_capture_value,
2110 (*ppTap)->ir_capture_mask );
2115 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
2121 struct command_context_s *context;
2125 JTAG_CMD_INIT_RESET,
2128 JTAG_CMD_TAPDISABLE,
2129 JTAG_CMD_TAPISENABLED,
2134 const Jim_Nvp jtag_cmds[] = {
2135 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
2136 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
2137 { .name = "newtap" , .value = JTAG_CMD_NEWTAP },
2138 { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED },
2139 { .name = "tapenable" , .value = JTAG_CMD_TAPENABLE },
2140 { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE },
2141 { .name = "configure" , .value = JTAG_CMD_CONFIGURE },
2142 { .name = "cget" , .value = JTAG_CMD_CGET },
2144 { .name = NULL, .value = -1 },
2147 context = Jim_GetAssocData(interp, "context");
2148 /* go past the command */
2149 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
2151 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
2153 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
2156 Jim_SetEmptyResult( goi.interp );
2158 case JTAG_CMD_INTERFACE:
2159 /* return the name of the interface */
2160 /* TCL code might need to know the exact type... */
2161 /* FUTURE: we allow this as a means to "set" the interface. */
2162 if( goi.argc != 0 ){
2163 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2166 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
2168 case JTAG_CMD_INIT_RESET:
2169 if( goi.argc != 0 ){
2170 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2173 e = jtag_init_reset(context);
2174 if( e != ERROR_OK ){
2175 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
2179 case JTAG_CMD_NEWTAP:
2180 return jim_newtap_cmd( &goi );
2182 case JTAG_CMD_TAPISENABLED:
2183 case JTAG_CMD_TAPENABLE:
2184 case JTAG_CMD_TAPDISABLE:
2185 if( goi.argc != 1 ){
2186 Jim_SetResultString( goi.interp, "Too many parameters",-1 );
2192 t = jtag_TapByJimObj( goi.interp, goi.argv[0] );
2197 case JTAG_CMD_TAPISENABLED:
2200 case JTAG_CMD_TAPENABLE:
2201 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
2205 case JTAG_CMD_TAPDISABLE:
2206 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
2211 Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
2218 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
2225 Jim_GetOpt_Obj(&goi, &o);
2226 t = jtag_TapByJimObj( goi.interp, o );
2231 goi.isconfigure = 0;
2232 return jtag_tap_configure_cmd( &goi, t);
2236 case JTAG_CMD_CONFIGURE:
2238 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
2245 Jim_GetOpt_Obj(&goi, &o);
2246 t = jtag_TapByJimObj( goi.interp, o );
2251 goi.isconfigure = 1;
2252 return jtag_tap_configure_cmd( &goi, t);
2259 int jtag_register_commands(struct command_context_s *cmd_ctx)
2261 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
2263 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
2264 COMMAND_CONFIG, "try to configure interface");
2265 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
2266 COMMAND_ANY, "set jtag speed (if supported)");
2267 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
2268 COMMAND_ANY, "same as jtag_speed, except it takes maximum khz as arguments. 0 KHz = RTCK.");
2269 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
2270 COMMAND_CONFIG, "jtag_device <ir_length> <ir_expected> <ir_mask>");
2271 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
2273 "[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]");
2274 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
2275 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
2276 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
2277 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
2279 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
2280 COMMAND_EXEC, "print current scan chain configuration");
2282 register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
2283 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
2284 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
2285 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
2286 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
2287 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
2288 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
2289 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
2290 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
2291 register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
2293 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
2294 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
2298 int jtag_interface_init(struct command_context_s *cmd_ctx)
2303 if (!jtag_interface)
2305 /* nothing was previously specified by "interface" command */
2306 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
2307 return ERROR_JTAG_INVALID_INTERFACE;
2311 jtag_interface->khz(speed_khz, &jtag_speed);
2315 if (jtag_interface->init() != ERROR_OK)
2316 return ERROR_JTAG_INIT_FAILED;
2318 jtag = jtag_interface;
2322 static int jtag_init_inner(struct command_context_s *cmd_ctx)
2327 LOG_DEBUG("Init JTAG chain");
2329 tap = jtag_NextEnabledTap(NULL);
2331 LOG_ERROR("There are no enabled taps?");
2332 return ERROR_JTAG_INIT_FAILED;
2336 if ((retval=jtag_execute_queue())!=ERROR_OK)
2339 /* examine chain first, as this could discover the real chain layout */
2340 if (jtag_examine_chain() != ERROR_OK)
2342 LOG_ERROR("trying to validate configured JTAG chain anyway...");
2345 if (jtag_validate_chain() != ERROR_OK)
2347 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
2353 int jtag_init_reset(struct command_context_s *cmd_ctx)
2357 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2360 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
2362 /* Reset can happen after a power cycle.
2364 * Ideally we would only assert TRST or run RESET before the target reset.
2366 * However w/srst_pulls_trst, trst is asserted together with the target
2367 * reset whether we want it or not.
2369 * NB! Some targets have JTAG circuitry disabled until a
2370 * trst & srst has been asserted.
2372 * NB! here we assume nsrst/ntrst delay are sufficient!
2374 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
2377 jtag_add_reset(1, 0); /* RESET or TRST */
2378 if (jtag_reset_config & RESET_HAS_SRST)
2380 jtag_add_reset(1, 1);
2381 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
2382 jtag_add_reset(0, 1);
2384 jtag_add_reset(0, 0);
2385 if ((retval = jtag_execute_queue()) != ERROR_OK)
2388 /* Check that we can communication on the JTAG chain + eventually we want to
2389 * be able to perform enumeration only after OpenOCD has started
2390 * telnet and GDB server
2392 * That would allow users to more easily perform any magic they need to before
2395 return jtag_init_inner(cmd_ctx);
2398 int jtag_init(struct command_context_s *cmd_ctx)
2401 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2403 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
2407 return jtag_init_reset(cmd_ctx);
2410 static int default_khz(int khz, int *jtag_speed)
2412 LOG_ERROR("Translation from khz to jtag_speed not implemented");
2416 static int default_speed_div(int speed, int *khz)
2418 LOG_ERROR("Translation from jtag_speed to khz not implemented");
2422 static int default_power_dropout(int *dropout)
2424 *dropout=0; /* by default we can't detect power dropout */
2428 static int default_srst_asserted(int *srst_asserted)
2430 *srst_asserted=0; /* by default we can't detect srst asserted */
2434 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2439 /* check whether the interface is already configured */
2442 LOG_WARNING("Interface already configured, ignoring");
2446 /* interface name is a mandatory argument */
2447 if (argc < 1 || args[0][0] == '\0')
2449 return ERROR_COMMAND_SYNTAX_ERROR;
2452 for (i=0; jtag_interfaces[i]; i++)
2454 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
2456 if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
2461 jtag_interface = jtag_interfaces[i];
2463 if (jtag_interface->khz == NULL)
2465 jtag_interface->khz = default_khz;
2467 if (jtag_interface->speed_div == NULL)
2469 jtag_interface->speed_div = default_speed_div;
2471 if (jtag_interface->power_dropout == NULL)
2473 jtag_interface->power_dropout = default_power_dropout;
2475 if (jtag_interface->srst_asserted == NULL)
2477 jtag_interface->srst_asserted = default_srst_asserted;
2484 /* no valid interface was found (i.e. the configuration option,
2485 * didn't match one of the compiled-in interfaces
2487 LOG_ERROR("No valid jtag interface found (%s)", args[0]);
2488 LOG_ERROR("compiled-in jtag interfaces:");
2489 for (i = 0; jtag_interfaces[i]; i++)
2491 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
2494 return ERROR_JTAG_INVALID_INTERFACE;
2497 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2501 Jim_Obj *newargs[ 10 ];
2504 * argv[-1] = command
2505 * argv[ 0] = ir length
2506 * argv[ 1] = ir capture
2507 * argv[ 2] = ir mask
2508 * argv[ 3] = not actually used by anything but in the docs
2512 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2515 command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2516 command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2520 command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2521 command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2522 command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2523 command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
2525 newargs[0] = Jim_NewStringObj( interp, "jtag", -1 );
2526 newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
2527 sprintf( buf, "chip%d", jtag_NumTotalTaps() );
2528 newargs[2] = Jim_NewStringObj( interp, buf, -1 );
2529 sprintf( buf, "tap%d", jtag_NumTotalTaps() );
2530 newargs[3] = Jim_NewStringObj( interp, buf, -1 );
2531 newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 );
2532 newargs[5] = Jim_NewStringObj( interp, args[0], -1 );
2533 newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 );
2534 newargs[7] = Jim_NewStringObj( interp, args[1], -1 );
2535 newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 );
2536 newargs[9] = Jim_NewStringObj( interp, args[2], -1 );
2538 command_print( cmd_ctx, "NEW COMMAND:");
2539 sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
2540 Jim_GetString( newargs[0], NULL ),
2541 Jim_GetString( newargs[1], NULL ),
2542 Jim_GetString( newargs[2], NULL ),
2543 Jim_GetString( newargs[3], NULL ),
2544 Jim_GetString( newargs[4], NULL ),
2545 Jim_GetString( newargs[5], NULL ),
2546 Jim_GetString( newargs[6], NULL ),
2547 Jim_GetString( newargs[7], NULL ),
2548 Jim_GetString( newargs[8], NULL ),
2549 Jim_GetString( newargs[9], NULL ) );
2551 e = jim_jtag_command( interp, 10, newargs );
2553 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
2558 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2562 tap = jtag_all_taps;
2563 command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
2564 command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
2567 u32 expected, expected_mask, cur_instr, ii;
2568 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
2569 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
2570 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
2572 command_print(cmd_ctx,
2573 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2574 tap->abs_chain_position,
2576 tap->enabled ? 'Y' : 'n',
2578 (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
2584 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
2585 command_print(cmd_ctx, " | | | | 0x%08x | | | | ",
2586 tap->expected_ids[ii]);
2589 tap = tap->next_tap;
2595 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2598 return ERROR_COMMAND_SYNTAX_ERROR;
2602 if (strcmp(args[0], "none") == 0)
2603 jtag_reset_config = RESET_NONE;
2604 else if (strcmp(args[0], "trst_only") == 0)
2605 jtag_reset_config = RESET_HAS_TRST;
2606 else if (strcmp(args[0], "srst_only") == 0)
2607 jtag_reset_config = RESET_HAS_SRST;
2608 else if (strcmp(args[0], "trst_and_srst") == 0)
2609 jtag_reset_config = RESET_TRST_AND_SRST;
2612 LOG_ERROR("(1) invalid reset_config argument (%s), defaulting to none", args[0]);
2613 jtag_reset_config = RESET_NONE;
2614 return ERROR_INVALID_ARGUMENTS;
2620 if (strcmp(args[1], "separate") == 0)
2622 /* seperate reset lines - default */
2625 if (strcmp(args[1], "srst_pulls_trst") == 0)
2626 jtag_reset_config |= RESET_SRST_PULLS_TRST;
2627 else if (strcmp(args[1], "trst_pulls_srst") == 0)
2628 jtag_reset_config |= RESET_TRST_PULLS_SRST;
2629 else if (strcmp(args[1], "combined") == 0)
2630 jtag_reset_config |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2633 LOG_ERROR("(2) invalid reset_config argument (%s), defaulting to none", args[1]);
2634 jtag_reset_config = RESET_NONE;
2635 return ERROR_INVALID_ARGUMENTS;
2642 if (strcmp(args[2], "trst_open_drain") == 0)
2643 jtag_reset_config |= RESET_TRST_OPEN_DRAIN;
2644 else if (strcmp(args[2], "trst_push_pull") == 0)
2645 jtag_reset_config &= ~RESET_TRST_OPEN_DRAIN;
2648 LOG_ERROR("(3) invalid reset_config argument (%s) defaulting to none", args[2] );
2649 jtag_reset_config = RESET_NONE;
2650 return ERROR_INVALID_ARGUMENTS;
2656 if (strcmp(args[3], "srst_push_pull") == 0)
2657 jtag_reset_config |= RESET_SRST_PUSH_PULL;
2658 else if (strcmp(args[3], "srst_open_drain") == 0)
2659 jtag_reset_config &= ~RESET_SRST_PUSH_PULL;
2662 LOG_ERROR("(4) invalid reset_config argument (%s), defaulting to none", args[3]);
2663 jtag_reset_config = RESET_NONE;
2664 return ERROR_INVALID_ARGUMENTS;
2671 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2675 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2680 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
2686 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2690 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2695 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
2701 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2703 int retval=ERROR_OK;
2707 LOG_DEBUG("handle jtag speed");
2710 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2712 /* this command can be called during CONFIG,
2713 * in which case jtag isn't initialized */
2716 retval=jtag->speed(cur_speed);
2718 } else if (argc == 0)
2722 return ERROR_COMMAND_SYNTAX_ERROR;
2724 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2729 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2731 int retval=ERROR_OK;
2732 LOG_DEBUG("handle jtag khz");
2736 speed_khz = strtoul(args[0], NULL, 0);
2740 LOG_DEBUG("have interface set up");
2742 if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
2748 cur_speed = jtag_speed = speed_div1;
2750 retval=jtag->speed(cur_speed);
2759 return ERROR_COMMAND_SYNTAX_ERROR;
2764 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
2770 command_print(cmd_ctx, "RCLK - adaptive");
2773 command_print(cmd_ctx, "%d kHz", speed_khz);
2779 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2785 return ERROR_COMMAND_SYNTAX_ERROR;
2789 state = tap_state_by_name( args[0] );
2791 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2792 return ERROR_COMMAND_SYNTAX_ERROR;
2794 jtag_add_end_state(state);
2795 jtag_execute_queue();
2797 command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
2802 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2809 return ERROR_COMMAND_SYNTAX_ERROR;
2812 if (args[0][0] == '1')
2814 else if (args[0][0] == '0')
2818 return ERROR_COMMAND_SYNTAX_ERROR;
2821 if (args[1][0] == '1')
2823 else if (args[1][0] == '0')
2827 return ERROR_COMMAND_SYNTAX_ERROR;
2830 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2831 return ERROR_JTAG_INIT_FAILED;
2833 jtag_add_reset(trst, srst);
2834 jtag_execute_queue();
2839 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2843 return ERROR_COMMAND_SYNTAX_ERROR;
2846 jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
2847 jtag_execute_queue();
2853 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2856 scan_field_t *fields;
2858 tap_state_t endstate;
2860 if ((argc < 2) || (argc % 2))
2862 return ERROR_COMMAND_SYNTAX_ERROR;
2865 /* optional "-endstate" */
2867 /* at the end of the arguments. */
2869 endstate = TAP_INVALID;
2871 /* have at least one pair of numbers. */
2872 /* is last pair the magic text? */
2873 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2876 cpA = args[ argc-1 ];
2877 for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2878 cpS = tap_state_name( endstate );
2879 if( 0 == strcmp( cpA, cpS ) ){
2883 if( endstate >= TAP_NUM_STATES ){
2884 return ERROR_COMMAND_SYNTAX_ERROR;
2886 /* found - remove the last 2 args */
2892 fields = malloc(sizeof(scan_field_t) * argc / 2);
2894 for (i = 0; i < argc / 2; i++)
2896 tap = jtag_TapByString( args[i*2] );
2899 command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2902 int field_size = tap->ir_length;
2903 fields[i].tap = tap;
2904 fields[i].out_value = malloc(CEIL(field_size, 8));
2905 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2906 fields[i].in_value = NULL;
2909 jtag_add_ir_scan(argc / 2, fields, TAP_INVALID);
2910 /* did we have an endstate? */
2911 if (endstate != TAP_INVALID)
2912 jtag_add_end_state(endstate);
2914 jtag_execute_queue();
2916 for (i = 0; i < argc / 2; i++)
2917 free(fields[i].out_value);
2924 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2927 scan_field_t *fields;
2929 int field_count = 0;
2932 tap_state_t endstate;
2935 * args[2] = num_bits
2936 * args[3] = hex string
2937 * ... repeat num bits and hex string ...
2940 * args[N-2] = "-endstate"
2941 * args[N-1] = statename
2943 if ((argc < 4) || ((argc % 2)!=0))
2945 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2949 /* assume no endstate */
2950 endstate = TAP_INVALID;
2951 /* validate arguments as numbers */
2953 for (i = 2; i < argc; i+=2)
2958 e = Jim_GetLong(interp, args[i], &bits);
2959 /* If valid - try next arg */
2964 /* Not valid.. are we at the end? */
2965 if ( ((i+2) != argc) ){
2966 /* nope, then error */
2970 /* it could be: "-endstate FOO" */
2972 /* get arg as a string. */
2973 cp = Jim_GetString( args[i], NULL );
2974 /* is it the magic? */
2975 if( 0 == strcmp( "-endstate", cp ) ){
2976 /* is the statename valid? */
2977 cp = Jim_GetString( args[i+1], NULL );
2979 /* see if it is a valid state name */
2980 endstate = tap_state_by_name(cp);
2982 /* update the error message */
2983 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
2985 /* valid - so clear the error */
2987 /* and remove the last 2 args */
2992 /* Still an error? */
2994 return e; /* too bad */
2996 } /* validate args */
2998 tap = jtag_TapByJimObj( interp, args[1] );
3003 num_fields=(argc-2)/2;
3004 fields = malloc(sizeof(scan_field_t) * num_fields);
3005 for (i = 2; i < argc; i+=2)
3011 Jim_GetLong(interp, args[i], &bits);
3012 str = Jim_GetString(args[i+1], &len);
3014 fields[field_count].tap = tap;
3015 fields[field_count].num_bits = bits;
3016 fields[field_count].out_value = malloc(CEIL(bits, 8));
3017 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
3018 fields[field_count].in_value = fields[field_count].out_value;
3022 jtag_add_dr_scan(num_fields, fields, TAP_INVALID);
3023 /* did we get an end state? */
3024 if (endstate != TAP_INVALID)
3025 jtag_add_end_state(endstate);
3027 retval = jtag_execute_queue();
3028 if (retval != ERROR_OK)
3030 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
3035 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
3036 for (i = 2; i < argc; i+=2)
3041 Jim_GetLong(interp, args[i], &bits);
3042 str = buf_to_str(fields[field_count].in_value, bits, 16);
3043 free(fields[field_count].out_value);
3045 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
3050 Jim_SetResult(interp, list);
3058 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
3060 Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_flush_queue_count));
3066 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3070 if (strcmp(args[0], "enable") == 0)
3072 jtag_verify_capture_ir = 1;
3074 else if (strcmp(args[0], "disable") == 0)
3076 jtag_verify_capture_ir = 0;
3079 return ERROR_COMMAND_SYNTAX_ERROR;
3081 } else if (argc != 0)
3083 return ERROR_COMMAND_SYNTAX_ERROR;
3086 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
3091 int jtag_power_dropout(int *dropout)
3093 return jtag->power_dropout(dropout);
3096 int jtag_srst_asserted(int *srst_asserted)
3098 return jtag->srst_asserted(srst_asserted);
3101 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
3103 jtag_tap_event_action_t * jteap;
3106 jteap = tap->event_action;
3110 if (jteap->event == e) {
3112 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
3115 Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
3116 Jim_GetString(jteap->body, NULL) );
3117 if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
3118 Jim_PrintErrorMessage(interp);
3122 jteap = jteap->next;
3126 LOG_DEBUG( "event %d %s - no action",
3128 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
3132 /*-----<Cable Helper API>---------------------------------------*/
3134 /* these Cable Helper API functions are all documented in the jtag.h header file,
3135 using a Doxygen format. And since Doxygen's configuration file "Doxyfile",
3136 is setup to prefer its docs in the header file, no documentation is here, for
3137 if it were, it would have to be doubly maintained.
3141 * @see tap_set_state() and tap_get_state() accessors.
3142 * Actual name is not important since accessors hide it.
3144 static tap_state_t state_follower = TAP_RESET;
3146 void tap_set_state_impl( tap_state_t new_state )
3148 /* this is the state we think the TAPs are in now, was cur_state */
3149 state_follower = new_state;
3152 tap_state_t tap_get_state()
3154 return state_follower;
3158 * @see tap_set_end_state() and tap_get_end_state() accessors.
3159 * Actual name is not important because accessors hide it.
3161 static tap_state_t end_state_follower = TAP_RESET;
3163 void tap_set_end_state( tap_state_t new_end_state )
3165 /* this is the state we think the TAPs will be in at completion of the
3166 current TAP operation, was end_state
3168 end_state_follower = new_end_state;
3171 tap_state_t tap_get_end_state()
3173 return end_state_follower;
3177 int tap_move_ndx( tap_state_t astate )
3179 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
3185 case TAP_RESET: ndx = 0; break;
3186 case TAP_DRSHIFT: ndx = 2; break;
3187 case TAP_DRPAUSE: ndx = 3; break;
3188 case TAP_IDLE: ndx = 1; break;
3189 case TAP_IRSHIFT: ndx = 4; break;
3190 case TAP_IRPAUSE: ndx = 5; break;
3192 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate) );
3200 /* tap_move[i][j]: tap movement command to go from state i to state j
3201 * 0: Test-Logic-Reset
3208 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
3215 } tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3217 /* value clocked to TMS to move from one of six stable states to another.
3218 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
3219 * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
3220 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
3221 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
3225 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
3226 * Read the bits from LSBit first to MSBit last (right-to-left).
3228 #define HEX__(n) 0x##n##LU
3231 (((x) & 0x0000000FLU)?(1<<0):0) \
3232 +(((x) & 0x000000F0LU)?(1<<1):0) \
3233 +(((x) & 0x00000F00LU)?(1<<2):0) \
3234 +(((x) & 0x0000F000LU)?(1<<3):0) \
3235 +(((x) & 0x000F0000LU)?(1<<4):0) \
3236 +(((x) & 0x00F00000LU)?(1<<5):0) \
3237 +(((x) & 0x0F000000LU)?(1<<6):0) \
3238 +(((x) & 0xF0000000LU)?(1<<7):0)
3240 #define B8(bits,count) { ((u8)B8__(HEX__(bits))), (count) }
3242 #if 0 && ((BUILD_FT2232_FTD2XX==1) || (BUILD_FT2232_LIBFTDI==1) || (BUILD_JLINK==1))
3243 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
3245 OK, I added Peter's version of the state table, and it works OK for
3246 me on MC1322x. I've recreated the jlink portion of patch with this
3247 new state table. His changes to my state table are pretty minor in
3248 terms of total transitions, but Peter feels that his version fixes
3249 some long-standing problems.
3252 I added the bit count into the table, reduced RESET column to 7 bits from 8.
3255 state specific comments:
3256 ------------------------
3257 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
3258 work better on ARM9 with ft2232 driver. (Dick)
3260 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3261 needed on ARM9 with ft2232 driver. (Dick)
3263 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3264 needed on ARM9 with ft2232 driver. (Dick)
3268 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3269 { B8(1111111,7), B8(0,1), B8(00101,5), B8(01010,5), B8(001101,6), B8(010110,6) }, /* RESET */
3270 { B8(1111111,7), B8(0,1), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
3271 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
3272 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
3273 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
3274 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
3276 #else /* this is the old table, converted from hex and with the bit_count set to 7 for each combo, like before */
3279 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3280 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3281 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
3282 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
3283 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
3284 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
3285 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0100000,7), B8(0101111,7) } /* IRPAUSE */
3289 #if 0 /* keeping old hex stuff for awhile, for reference */
3290 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */
3291 { 0x7f, 0x00, 0x17, 0x0a, 0x1b, 0x16 }, /* RESET */
3292 { 0x7f, 0x00, 0x25, 0x05, 0x2b, 0x0b }, /* IDLE */
3293 { 0x7f, 0x31, 0x00, 0x01, 0x0f, 0x2f }, /* DRSHIFT */
3294 { 0x7f, 0x30, 0x20, 0x17, 0x1e, 0x2f }, /* DRPAUSE */
3295 { 0x7f, 0x31, 0x07, 0x17, 0x00, 0x01 }, /* IRSHIFT */
3296 { 0x7f, 0x30, 0x1c, 0x17, 0x20, 0x2f } /* IRPAUSE */
3301 int tap_get_tms_path( tap_state_t from, tap_state_t to )
3303 return tms_seqs[tap_move_ndx(from)][tap_move_ndx(to)].bits;
3307 int tap_get_tms_path_len( tap_state_t from, tap_state_t to )
3309 return tms_seqs[tap_move_ndx(from)][tap_move_ndx(to)].bit_count;
3313 bool tap_is_state_stable(tap_state_t astate)
3317 /* A switch() is used because it is symbol dependent
3318 (not value dependent like an array), and can also check bounds.
3337 tap_state_t tap_state_transition(tap_state_t cur_state, bool tms)
3339 tap_state_t new_state;
3341 /* A switch is used because it is symbol dependent and not value dependent
3342 like an array. Also it can check for out of range conditions.
3350 new_state = cur_state;
3355 new_state = TAP_DRSELECT;
3358 new_state = TAP_IRSELECT;
3362 new_state = TAP_DREXIT1;
3366 new_state = TAP_DRUPDATE;
3369 new_state = TAP_DREXIT2;
3372 new_state = TAP_RESET;
3376 new_state = TAP_IREXIT1;
3380 new_state = TAP_IRUPDATE;
3383 new_state = TAP_IREXIT2;
3386 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3399 new_state = TAP_IDLE;
3402 new_state = TAP_DRCAPTURE;
3407 new_state = TAP_DRSHIFT;
3411 new_state = TAP_DRPAUSE;
3414 new_state = TAP_IRCAPTURE;
3419 new_state = TAP_IRSHIFT;
3423 new_state = TAP_IRPAUSE;
3426 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3435 const char* tap_state_name(tap_state_t state)
3441 case TAP_RESET: ret = "RESET"; break;
3442 case TAP_IDLE: ret = "RUN/IDLE"; break;
3443 case TAP_DRSELECT: ret = "DRSELECT"; break;
3444 case TAP_DRCAPTURE: ret = "DRCAPTURE"; break;
3445 case TAP_DRSHIFT: ret = "DRSHIFT"; break;
3446 case TAP_DREXIT1: ret = "DREXIT1"; break;
3447 case TAP_DRPAUSE: ret = "DRPAUSE"; break;
3448 case TAP_DREXIT2: ret = "DREXIT2"; break;
3449 case TAP_DRUPDATE: ret = "DRUPDATE"; break;
3450 case TAP_IRSELECT: ret = "IRSELECT"; break;
3451 case TAP_IRCAPTURE: ret = "IRCAPTURE"; break;
3452 case TAP_IRSHIFT: ret = "IRSHIFT"; break;
3453 case TAP_IREXIT1: ret = "IREXIT1"; break;
3454 case TAP_IRPAUSE: ret = "IRPAUSE"; break;
3455 case TAP_IREXIT2: ret = "IREXIT2"; break;
3456 case TAP_IRUPDATE: ret = "IRUPDATE"; break;
3457 default: ret = "???";
3463 static tap_state_t tap_state_by_name( const char *name )
3467 for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
3468 /* be nice to the human */
3469 if( 0 == strcasecmp( name, tap_state_name(x) ) ){
3477 #ifdef _DEBUG_JTAG_IO_
3479 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3480 do { buf[len] = bit ? '1' : '0'; } while(0)
3481 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3482 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3483 tap_state_name(a), tap_state_name(b), astr, bstr)
3485 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
3486 unsigned tap_bits, tap_state_t next_state)
3488 const u8 *tms_buffer;
3489 const u8 *tdi_buffer;
3494 unsigned tap_out_bits;
3498 tap_state_t last_state;
3500 // set startstate (and possibly last, if tap_bits == 0)
3501 last_state = next_state;
3502 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
3504 tms_buffer = (const u8 *)tms_buf;
3505 tdi_buffer = (const u8 *)tdi_buf;
3507 tap_bytes = TAP_SCAN_BYTES(tap_bits);
3508 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
3511 for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
3513 for(cur_bit = 0; cur_bit < 8; cur_bit++)
3515 // make sure we do not run off the end of the buffers
3516 unsigned tap_bit = cur_byte * 8 + cur_bit;
3517 if (tap_bit == tap_bits)
3520 // check and save TMS bit
3521 tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
3522 JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
3524 // use TMS bit to find the next TAP state
3525 next_state = tap_state_transition(last_state, tap_bit);
3527 // check and store TDI bit
3528 tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
3529 JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
3531 // increment TAP bits
3534 // Only show TDO bits on state transitions, or
3535 // after some number of bits in the same state.
3536 if ((next_state == last_state) && (tap_out_bits < 32))
3539 // terminate strings and display state transition
3540 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3541 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3544 last_state = next_state;
3551 // terminate strings and display state transition
3552 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3553 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3556 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
3560 #endif // _DEBUG_JTAG_IO_
3562 /*-----</Cable Helper API>--------------------------------------*/