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 ***************************************************************************/
31 #include "replacements.h"
47 /* note that this is not marked as static as it must be available from outside jtag.c for those
48 that implement the jtag_xxx() minidriver layer
50 int jtag_error=ERROR_OK;
52 typedef struct cmd_queue_page_s
56 struct cmd_queue_page_s *next;
59 #define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
60 static cmd_queue_page_t *cmd_queue_pages = NULL;
62 char* jtag_event_strings[] =
64 "JTAG controller reset (RESET or TRST)"
67 const Jim_Nvp nvp_jtag_tap_event[] = {
68 { .value = JTAG_TAP_EVENT_ENABLE, .name = "tap-enable" },
69 { .value = JTAG_TAP_EVENT_DISABLE, .name = "tap-disable" },
71 { .name = NULL, .value = -1 }
77 jtag_command_t *jtag_command_queue = NULL;
78 jtag_command_t **last_comand_pointer = &jtag_command_queue;
79 static jtag_tap_t *jtag_all_taps = NULL;
81 enum reset_types jtag_reset_config = RESET_NONE;
82 tap_state_t cmd_queue_end_state = TAP_RESET;
83 tap_state_t cmd_queue_cur_state = TAP_RESET;
85 int jtag_verify_capture_ir = 1;
87 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
88 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
89 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
91 /* maximum number of JTAG devices expected in the chain
93 #define JTAG_MAX_CHAIN_SIZE 20
95 /* callbacks to inform high-level handlers about JTAG state changes */
96 jtag_event_callback_t *jtag_event_callbacks;
99 static int speed_khz = 0;
100 /* flag if the kHz speed was defined */
101 static int hasKHz = 0;
103 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
106 #if BUILD_ECOSBOARD == 1
107 extern jtag_interface_t zy1000_interface;
110 #if BUILD_PARPORT == 1
111 extern jtag_interface_t parport_interface;
115 extern jtag_interface_t dummy_interface;
118 #if BUILD_FT2232_FTD2XX == 1
119 extern jtag_interface_t ft2232_interface;
122 #if BUILD_FT2232_LIBFTDI == 1
123 extern jtag_interface_t ft2232_interface;
126 #if BUILD_AMTJTAGACCEL == 1
127 extern jtag_interface_t amt_jtagaccel_interface;
130 #if BUILD_EP93XX == 1
131 extern jtag_interface_t ep93xx_interface;
134 #if BUILD_AT91RM9200 == 1
135 extern jtag_interface_t at91rm9200_interface;
138 #if BUILD_GW16012 == 1
139 extern jtag_interface_t gw16012_interface;
142 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
143 extern jtag_interface_t presto_interface;
146 #if BUILD_USBPROG == 1
147 extern jtag_interface_t usbprog_interface;
151 extern jtag_interface_t jlink_interface;
154 #if BUILD_VSLLINK == 1
155 extern jtag_interface_t vsllink_interface;
159 extern jtag_interface_t rlink_interface;
162 #if BUILD_ARMJTAGEW == 1
163 extern jtag_interface_t armjtagew_interface;
166 jtag_interface_t *jtag_interfaces[] = {
167 #if BUILD_ECOSBOARD == 1
170 #if BUILD_PARPORT == 1
176 #if BUILD_FT2232_FTD2XX == 1
179 #if BUILD_FT2232_LIBFTDI == 1
182 #if BUILD_AMTJTAGACCEL == 1
183 &amt_jtagaccel_interface,
185 #if BUILD_EP93XX == 1
188 #if BUILD_AT91RM9200 == 1
189 &at91rm9200_interface,
191 #if BUILD_GW16012 == 1
194 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
197 #if BUILD_USBPROG == 1
203 #if BUILD_VSLLINK == 1
209 #if BUILD_ARMJTAGEW == 1
210 &armjtagew_interface,
215 jtag_interface_t *jtag = NULL;
218 static jtag_interface_t *jtag_interface = NULL;
221 /* forward declarations */
222 //void jtag_add_pathmove(int num_states, tap_state_t *path);
223 //void jtag_add_runtest(int num_cycles, tap_state_t endstate);
224 //void jtag_add_end_state(tap_state_t endstate);
225 //void jtag_add_sleep(u32 us);
226 //int jtag_execute_queue(void);
227 static tap_state_t tap_state_by_name(const char *name);
230 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
231 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
232 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
233 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
234 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
235 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
236 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
238 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
240 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
241 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
242 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
243 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
244 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
246 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
248 jtag_tap_t *jtag_AllTaps(void)
250 return jtag_all_taps;
253 int jtag_NumTotalTaps(void)
267 int jtag_NumEnabledTaps(void)
283 jtag_tap_t *jtag_TapByString( const char *s )
291 if( 0 == strcmp( t->dotted_name, s ) ){
297 /* backup plan is by number */
299 /* ok - is "s" a number? */
301 n = strtol( s, &cp, 0 );
302 if( (s != cp) && (*cp == 0) ){
304 t = jtag_TapByAbsPosition(n);
310 jtag_tap_t * jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *o )
315 cp = Jim_GetString( o, NULL );
320 t = jtag_TapByString( cp );
323 Jim_SetResult_sprintf(interp,"Tap: %s is unknown", cp );
328 /* returns a pointer to the n-th device in the scan chain */
329 jtag_tap_t * jtag_TapByAbsPosition( int n )
337 while( t && (n > 0)) {
344 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
346 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
348 if (callback == NULL)
350 return ERROR_INVALID_ARGUMENTS;
355 while ((*callbacks_p)->next)
356 callbacks_p = &((*callbacks_p)->next);
357 callbacks_p = &((*callbacks_p)->next);
360 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
361 (*callbacks_p)->callback = callback;
362 (*callbacks_p)->priv = priv;
363 (*callbacks_p)->next = NULL;
368 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
370 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
372 if (callback == NULL)
374 return ERROR_INVALID_ARGUMENTS;
379 jtag_event_callback_t **next = &((*callbacks_p)->next);
380 if ((*callbacks_p)->callback == callback)
383 *callbacks_p = *next;
391 int jtag_call_event_callbacks(enum jtag_event event)
393 jtag_event_callback_t *callback = jtag_event_callbacks;
395 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
399 callback->callback(event, callback->priv);
400 callback = callback->next;
406 /* returns a pointer to the pointer of the last command in queue
407 * this may be a pointer to the root pointer (jtag_command_queue)
408 * or to the next member of the last but one command
410 jtag_command_t** jtag_get_last_command_p(void)
412 /* jtag_command_t *cmd = jtag_command_queue;
418 return &jtag_command_queue;
422 return last_comand_pointer;
425 void* cmd_queue_alloc(size_t size)
427 cmd_queue_page_t **p_page = &cmd_queue_pages;
433 * We align/round the *SIZE* per below
434 * so that all pointers returned by
435 * this function are reasonably well
438 * If we did not, then an "odd-length" request would cause the
439 * *next* allocation to be at an *odd* address, and because
440 * this function has the same type of api as malloc() - we
441 * must also return pointers that have the same type of
444 * What I do not/have is a reasonable portable means
447 * The solution here, is based on these suggestions.
448 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
451 union worse_case_align {
457 #define ALIGN_SIZE (sizeof(union worse_case_align))
459 /* The alignment process. */
460 size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
465 while ((*p_page)->next)
466 p_page = &((*p_page)->next);
467 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
468 p_page = &((*p_page)->next);
473 *p_page = malloc(sizeof(cmd_queue_page_t));
475 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
476 (*p_page)->next = NULL;
479 offset = (*p_page)->used;
480 (*p_page)->used += size;
482 t=(u8 *)((*p_page)->address);
486 void cmd_queue_free(void)
488 cmd_queue_page_t *page = cmd_queue_pages;
492 cmd_queue_page_t *last = page;
498 cmd_queue_pages = NULL;
501 static void jtag_prelude1(void)
505 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
506 jtag_error=ERROR_JTAG_TRST_ASSERTED;
510 if (cmd_queue_end_state == TAP_RESET)
511 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
514 static void jtag_prelude(tap_state_t state)
518 if (state != TAP_INVALID)
519 jtag_add_end_state(state);
521 cmd_queue_cur_state = cmd_queue_end_state;
524 void jtag_add_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
530 retval=interface_jtag_add_ir_scan(num_fields, fields, cmd_queue_end_state);
531 if (retval!=ERROR_OK)
535 int MINIDRIVER(interface_jtag_add_ir_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
537 jtag_command_t **last_cmd;
544 last_cmd = jtag_get_last_command_p();
546 /* allocate memory for a new list member */
547 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
548 (*last_cmd)->next = NULL;
549 last_comand_pointer = &((*last_cmd)->next);
550 (*last_cmd)->type = JTAG_SCAN;
552 /* allocate memory for ir scan command */
553 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
554 (*last_cmd)->cmd.scan->ir_scan = 1;
555 x = jtag_NumEnabledTaps();
556 (*last_cmd)->cmd.scan->num_fields = x; /* one field per device */
557 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(x * sizeof(scan_field_t));
558 (*last_cmd)->cmd.scan->end_state = state;
565 /* do this here so it is not forgotten */
566 tap = jtag_NextEnabledTap(tap);
571 scan_size = tap->ir_length;
572 (*last_cmd)->cmd.scan->fields[nth_tap].tap = tap;
573 (*last_cmd)->cmd.scan->fields[nth_tap].num_bits = scan_size;
574 (*last_cmd)->cmd.scan->fields[nth_tap].in_value = NULL;
575 (*last_cmd)->cmd.scan->fields[nth_tap].in_handler = NULL; /* disable verification by default */
577 /* search the list */
578 for (j = 0; j < num_fields; j++)
580 if (tap == fields[j].tap)
583 (*last_cmd)->cmd.scan->fields[nth_tap].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
585 if (jtag_verify_capture_ir)
587 if (fields[j].in_handler==NULL)
589 jtag_set_check_value((*last_cmd)->cmd.scan->fields+nth_tap, tap->expected, tap->expected_mask, NULL);
592 (*last_cmd)->cmd.scan->fields[nth_tap].in_handler = fields[j].in_handler;
593 (*last_cmd)->cmd.scan->fields[nth_tap].in_handler_priv = fields[j].in_handler_priv;
594 (*last_cmd)->cmd.scan->fields[nth_tap].in_check_value = tap->expected;
595 (*last_cmd)->cmd.scan->fields[nth_tap].in_check_mask = tap->expected_mask;
606 /* if a tap isn't listed, set it to BYPASS */
607 (*last_cmd)->cmd.scan->fields[nth_tap].out_value = buf_set_ones(cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
611 /* update device information */
612 buf_cpy((*last_cmd)->cmd.scan->fields[nth_tap].out_value, tap->cur_instr, scan_size);
618 void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
624 retval=interface_jtag_add_plain_ir_scan(num_fields, fields, cmd_queue_end_state);
625 if (retval!=ERROR_OK)
629 int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
632 jtag_command_t **last_cmd;
634 last_cmd = jtag_get_last_command_p();
636 /* allocate memory for a new list member */
637 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
638 (*last_cmd)->next = NULL;
639 last_comand_pointer = &((*last_cmd)->next);
640 (*last_cmd)->type = JTAG_SCAN;
642 /* allocate memory for ir scan command */
643 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
644 (*last_cmd)->cmd.scan->ir_scan = 1;
645 (*last_cmd)->cmd.scan->num_fields = num_fields;
646 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
647 (*last_cmd)->cmd.scan->end_state = state;
649 for( i = 0 ; i < num_fields ; i++ ){
650 int num_bits = fields[i].num_bits;
651 int num_bytes = CEIL(fields[i].num_bits, 8);
652 (*last_cmd)->cmd.scan->fields[i].tap = fields[i].tap;
653 (*last_cmd)->cmd.scan->fields[i].num_bits = num_bits;
654 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
655 (*last_cmd)->cmd.scan->fields[i].in_value = fields[i].in_value;
656 (*last_cmd)->cmd.scan->fields[i].in_check_value = fields[i].in_check_value;
657 (*last_cmd)->cmd.scan->fields[i].in_check_mask = fields[i].in_check_mask;
658 (*last_cmd)->cmd.scan->fields[i].in_handler = NULL;
659 (*last_cmd)->cmd.scan->fields[i].in_handler_priv = NULL;
664 void jtag_add_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
670 retval=interface_jtag_add_dr_scan(num_fields, fields, cmd_queue_end_state);
671 if (retval!=ERROR_OK)
675 void jtag_add_dr_scan_now(int num_fields, scan_field_t *fields, tap_state_t state)
677 jtag_add_dr_scan(num_fields, fields, state);
678 jtag_execute_queue_noclear();
681 int MINIDRIVER(interface_jtag_add_dr_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
685 int bypass_devices = 0;
689 jtag_command_t **last_cmd = jtag_get_last_command_p();
692 /* count devices in bypass */
696 tap = jtag_NextEnabledTap(tap);
705 /* allocate memory for a new list member */
706 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
707 last_comand_pointer = &((*last_cmd)->next);
708 (*last_cmd)->next = NULL;
709 (*last_cmd)->type = JTAG_SCAN;
711 /* allocate memory for dr scan command */
712 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
713 (*last_cmd)->cmd.scan->ir_scan = 0;
714 (*last_cmd)->cmd.scan->num_fields = num_fields + bypass_devices;
715 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
716 (*last_cmd)->cmd.scan->end_state = state;
722 tap = jtag_NextEnabledTap(tap);
727 (*last_cmd)->cmd.scan->fields[field_count].tap = tap;
729 for (j = 0; j < num_fields; j++)
731 if (tap == fields[j].tap)
734 scan_size = fields[j].num_bits;
735 (*last_cmd)->cmd.scan->fields[field_count].num_bits = scan_size;
736 (*last_cmd)->cmd.scan->fields[field_count].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
737 (*last_cmd)->cmd.scan->fields[field_count].in_value = fields[j].in_value;
738 (*last_cmd)->cmd.scan->fields[field_count].in_check_value = fields[j].in_check_value;
739 (*last_cmd)->cmd.scan->fields[field_count].in_check_mask = fields[j].in_check_mask;
740 (*last_cmd)->cmd.scan->fields[field_count].in_handler = fields[j].in_handler;
741 (*last_cmd)->cmd.scan->fields[field_count++].in_handler_priv = fields[j].in_handler_priv;
746 #ifdef _DEBUG_JTAG_IO_
747 /* if a device isn't listed, the BYPASS register should be selected */
750 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
754 /* program the scan field to 1 bit length, and ignore it's value */
755 (*last_cmd)->cmd.scan->fields[field_count].num_bits = 1;
756 (*last_cmd)->cmd.scan->fields[field_count].out_value = NULL;
757 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
758 (*last_cmd)->cmd.scan->fields[field_count].in_check_value = NULL;
759 (*last_cmd)->cmd.scan->fields[field_count].in_check_mask = NULL;
760 (*last_cmd)->cmd.scan->fields[field_count].in_handler = NULL;
761 (*last_cmd)->cmd.scan->fields[field_count++].in_handler_priv = NULL;
765 #ifdef _DEBUG_JTAG_IO_
766 /* if a device is listed, the BYPASS register must not be selected */
769 LOG_ERROR("BUG: scan data for a device in BYPASS");
778 void MINIDRIVER(interface_jtag_add_dr_out)(jtag_tap_t *target_tap,
782 tap_state_t end_state)
787 int bypass_devices = 0;
789 jtag_command_t **last_cmd = jtag_get_last_command_p();
792 /* count devices in bypass */
796 tap = jtag_NextEnabledTap(tap);
805 /* allocate memory for a new list member */
806 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
807 last_comand_pointer = &((*last_cmd)->next);
808 (*last_cmd)->next = NULL;
809 (*last_cmd)->type = JTAG_SCAN;
811 /* allocate memory for dr scan command */
812 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
813 (*last_cmd)->cmd.scan->ir_scan = 0;
814 (*last_cmd)->cmd.scan->num_fields = num_fields + bypass_devices;
815 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
816 (*last_cmd)->cmd.scan->end_state = end_state;
821 tap = jtag_NextEnabledTap(tap);
826 (*last_cmd)->cmd.scan->fields[field_count].tap = tap;
828 if (tap == target_tap)
831 #ifdef _DEBUG_JTAG_IO_
832 /* if a device is listed, the BYPASS register must not be selected */
835 LOG_ERROR("BUG: scan data for a device in BYPASS");
839 for (j = 0; j < num_fields; j++)
842 scan_size = num_bits[j];
843 buf_set_u32(out_value, 0, scan_size, value[j]);
844 (*last_cmd)->cmd.scan->fields[field_count].num_bits = scan_size;
845 (*last_cmd)->cmd.scan->fields[field_count].out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
846 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
847 (*last_cmd)->cmd.scan->fields[field_count].in_check_value = NULL;
848 (*last_cmd)->cmd.scan->fields[field_count].in_check_mask = NULL;
849 (*last_cmd)->cmd.scan->fields[field_count].in_handler = NULL;
850 (*last_cmd)->cmd.scan->fields[field_count++].in_handler_priv = NULL;
854 #ifdef _DEBUG_JTAG_IO_
855 /* if a device isn't listed, the BYPASS register should be selected */
858 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
862 /* program the scan field to 1 bit length, and ignore it's value */
863 (*last_cmd)->cmd.scan->fields[field_count].num_bits = 1;
864 (*last_cmd)->cmd.scan->fields[field_count].out_value = NULL;
865 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
866 (*last_cmd)->cmd.scan->fields[field_count].in_check_value = NULL;
867 (*last_cmd)->cmd.scan->fields[field_count].in_check_mask = NULL;
868 (*last_cmd)->cmd.scan->fields[field_count].in_handler = NULL;
869 (*last_cmd)->cmd.scan->fields[field_count++].in_handler_priv = NULL;
874 void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
880 retval=interface_jtag_add_plain_dr_scan(num_fields, fields, cmd_queue_end_state);
881 if (retval!=ERROR_OK)
885 int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int num_fields, scan_field_t *fields, tap_state_t state)
888 jtag_command_t **last_cmd = jtag_get_last_command_p();
890 /* allocate memory for a new list member */
891 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
892 last_comand_pointer = &((*last_cmd)->next);
893 (*last_cmd)->next = NULL;
894 (*last_cmd)->type = JTAG_SCAN;
896 /* allocate memory for scan command */
897 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
898 (*last_cmd)->cmd.scan->ir_scan = 0;
899 (*last_cmd)->cmd.scan->num_fields = num_fields;
900 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
901 (*last_cmd)->cmd.scan->end_state = state;
903 for (i = 0; i < num_fields; i++)
905 int num_bits = fields[i].num_bits;
906 int num_bytes = CEIL(fields[i].num_bits, 8);
907 (*last_cmd)->cmd.scan->fields[i].tap = fields[i].tap;
908 (*last_cmd)->cmd.scan->fields[i].num_bits = num_bits;
909 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
910 (*last_cmd)->cmd.scan->fields[i].in_value = fields[i].in_value;
911 (*last_cmd)->cmd.scan->fields[i].in_check_value = fields[i].in_check_value;
912 (*last_cmd)->cmd.scan->fields[i].in_check_mask = fields[i].in_check_mask;
913 (*last_cmd)->cmd.scan->fields[i].in_handler = fields[i].in_handler;
914 (*last_cmd)->cmd.scan->fields[i].in_handler_priv = fields[i].in_handler_priv;
920 void jtag_add_tlr(void)
922 jtag_prelude(TAP_RESET);
925 retval=interface_jtag_add_tlr();
926 if (retval!=ERROR_OK)
930 int MINIDRIVER(interface_jtag_add_tlr)(void)
932 tap_state_t state = TAP_RESET;
933 jtag_command_t **last_cmd = jtag_get_last_command_p();
935 /* allocate memory for a new list member */
936 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
937 last_comand_pointer = &((*last_cmd)->next);
938 (*last_cmd)->next = NULL;
939 (*last_cmd)->type = JTAG_STATEMOVE;
941 (*last_cmd)->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
942 (*last_cmd)->cmd.statemove->end_state = state;
947 void jtag_add_pathmove(int num_states, tap_state_t *path)
949 tap_state_t cur_state = cmd_queue_cur_state;
953 /* the last state has to be a stable state */
954 if (!tap_is_state_stable(path[num_states - 1]))
956 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
960 for (i=0; i<num_states; i++)
962 if (path[i] == TAP_RESET)
964 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
968 if ( tap_state_transition(cur_state, true) != path[i]
969 && tap_state_transition(cur_state, false) != path[i])
971 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
979 retval = interface_jtag_add_pathmove(num_states, path);
980 cmd_queue_cur_state = path[num_states - 1];
981 if (retval!=ERROR_OK)
985 int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, tap_state_t *path)
987 jtag_command_t **last_cmd = jtag_get_last_command_p();
990 /* allocate memory for a new list member */
991 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
992 last_comand_pointer = &((*last_cmd)->next);
993 (*last_cmd)->next = NULL;
994 (*last_cmd)->type = JTAG_PATHMOVE;
996 (*last_cmd)->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
997 (*last_cmd)->cmd.pathmove->num_states = num_states;
998 (*last_cmd)->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);
1000 for (i = 0; i < num_states; i++)
1001 (*last_cmd)->cmd.pathmove->path[i] = path[i];
1006 int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, tap_state_t state)
1008 jtag_command_t **last_cmd = jtag_get_last_command_p();
1010 /* allocate memory for a new list member */
1011 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1012 (*last_cmd)->next = NULL;
1013 last_comand_pointer = &((*last_cmd)->next);
1014 (*last_cmd)->type = JTAG_RUNTEST;
1016 (*last_cmd)->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
1017 (*last_cmd)->cmd.runtest->num_cycles = num_cycles;
1018 (*last_cmd)->cmd.runtest->end_state = state;
1023 void jtag_add_runtest(int num_cycles, tap_state_t state)
1027 jtag_prelude(state);
1029 /* executed by sw or hw fifo */
1030 retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
1031 if (retval!=ERROR_OK)
1036 int MINIDRIVER(interface_jtag_add_clocks)( int num_cycles )
1038 jtag_command_t **last_cmd = jtag_get_last_command_p();
1040 /* allocate memory for a new list member */
1041 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1042 (*last_cmd)->next = NULL;
1043 last_comand_pointer = &((*last_cmd)->next);
1044 (*last_cmd)->type = JTAG_STABLECLOCKS;
1046 (*last_cmd)->cmd.stableclocks = cmd_queue_alloc(sizeof(stableclocks_command_t));
1047 (*last_cmd)->cmd.stableclocks->num_cycles = num_cycles;
1051 void jtag_add_clocks( int num_cycles )
1055 if( !tap_is_state_stable(cmd_queue_cur_state) )
1057 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
1058 tap_state_name(cmd_queue_cur_state) );
1059 jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
1063 if( num_cycles > 0 )
1067 retval = interface_jtag_add_clocks(num_cycles);
1068 if (retval != ERROR_OK)
1073 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
1075 int trst_with_tlr = 0;
1078 /* FIX!!! there are *many* different cases here. A better
1079 * approach is needed for legal combinations of transitions...
1081 if ((jtag_reset_config & RESET_HAS_SRST)&&
1082 (jtag_reset_config & RESET_HAS_TRST)&&
1083 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
1085 if (((req_tlr_or_trst&&!jtag_trst)||
1086 (!req_tlr_or_trst&&jtag_trst))&&
1087 ((req_srst&&!jtag_srst)||
1088 (!req_srst&&jtag_srst)))
1090 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
1091 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
1095 /* Make sure that jtag_reset_config allows the requested reset */
1096 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
1097 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
1099 LOG_ERROR("BUG: requested reset would assert trst");
1100 jtag_error=ERROR_FAIL;
1104 /* if TRST pulls SRST, we reset with TAP T-L-R */
1105 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
1110 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
1112 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
1113 jtag_error=ERROR_FAIL;
1117 if (req_tlr_or_trst)
1119 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
1131 jtag_srst = req_srst;
1133 retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
1134 if (retval!=ERROR_OK)
1142 LOG_DEBUG("SRST line asserted");
1146 LOG_DEBUG("SRST line released");
1147 if (jtag_nsrst_delay)
1148 jtag_add_sleep(jtag_nsrst_delay * 1000);
1153 LOG_DEBUG("JTAG reset with RESET instead of TRST");
1154 jtag_add_end_state(TAP_RESET);
1156 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1162 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1163 * and inform possible listeners about this
1165 LOG_DEBUG("TRST line asserted");
1166 cmd_queue_cur_state = TAP_RESET;
1167 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1171 if (jtag_ntrst_delay)
1172 jtag_add_sleep(jtag_ntrst_delay * 1000);
1176 int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
1178 jtag_command_t **last_cmd = jtag_get_last_command_p();
1180 /* allocate memory for a new list member */
1181 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1182 (*last_cmd)->next = NULL;
1183 last_comand_pointer = &((*last_cmd)->next);
1184 (*last_cmd)->type = JTAG_RESET;
1186 (*last_cmd)->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
1187 (*last_cmd)->cmd.reset->trst = req_trst;
1188 (*last_cmd)->cmd.reset->srst = req_srst;
1193 void jtag_add_end_state(tap_state_t state)
1195 cmd_queue_end_state = state;
1196 if ((cmd_queue_end_state == TAP_DRSHIFT)||(cmd_queue_end_state == TAP_IRSHIFT))
1198 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
1202 int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
1204 jtag_command_t **last_cmd = jtag_get_last_command_p();
1206 /* allocate memory for a new list member */
1207 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1208 (*last_cmd)->next = NULL;
1209 last_comand_pointer = &((*last_cmd)->next);
1210 (*last_cmd)->type = JTAG_SLEEP;
1212 (*last_cmd)->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
1213 (*last_cmd)->cmd.sleep->us = us;
1218 void jtag_add_sleep(u32 us)
1220 keep_alive(); /* we might be running on a very slow JTAG clk */
1221 int retval=interface_jtag_add_sleep(us);
1222 if (retval!=ERROR_OK)
1227 int jtag_scan_size(scan_command_t *cmd)
1232 /* count bits in scan command */
1233 for (i = 0; i < cmd->num_fields; i++)
1235 bit_count += cmd->fields[i].num_bits;
1241 int jtag_build_buffer(scan_command_t *cmd, u8 **buffer)
1246 bit_count = jtag_scan_size(cmd);
1247 *buffer = malloc(CEIL(bit_count, 8));
1251 #ifdef _DEBUG_JTAG_IO_
1252 LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
1255 for (i = 0; i < cmd->num_fields; i++)
1257 if (cmd->fields[i].out_value)
1259 #ifdef _DEBUG_JTAG_IO_
1260 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);
1262 buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
1263 #ifdef _DEBUG_JTAG_IO_
1264 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
1270 #ifdef _DEBUG_JTAG_IO_
1271 LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
1275 bit_count += cmd->fields[i].num_bits;
1278 #ifdef _DEBUG_JTAG_IO_
1279 //LOG_DEBUG("bit_count totalling: %i", bit_count );
1285 int jtag_read_buffer(u8 *buffer, scan_command_t *cmd)
1291 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1294 for (i = 0; i < cmd->num_fields; i++)
1296 /* if neither in_value nor in_handler
1297 * are specified we don't have to examine this field
1299 if (cmd->fields[i].in_value || cmd->fields[i].in_handler)
1301 int num_bits = cmd->fields[i].num_bits;
1302 u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
1304 #ifdef _DEBUG_JTAG_IO_
1305 char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1306 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
1310 if (cmd->fields[i].in_value)
1312 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
1314 if (cmd->fields[i].in_handler)
1316 if (cmd->fields[i].in_handler(cmd->fields[i].in_value, cmd->fields[i].in_handler_priv, cmd->fields+i) != ERROR_OK)
1318 LOG_WARNING("in_handler: with \"in_value\", mismatch in %s", cmd->ir_scan ? "SIR" : "SDR" );
1319 retval = ERROR_JTAG_QUEUE_FAILED;
1324 /* no in_value specified, but a handler takes care of the scanned data */
1325 if (cmd->fields[i].in_handler && (!cmd->fields[i].in_value))
1327 if (cmd->fields[i].in_handler(captured, cmd->fields[i].in_handler_priv, cmd->fields+i) != ERROR_OK)
1329 /* We're going to call the error:handler later, but if the in_handler
1330 * reported an error we report this failure upstream
1332 LOG_WARNING("in_handler: w/o \"in_value\", mismatch in %s", cmd->ir_scan ? "SIR" : "SDR" );
1333 retval = ERROR_JTAG_QUEUE_FAILED;
1339 bit_count += cmd->fields[i].num_bits;
1345 static const char *jtag_tap_name(jtag_tap_t *tap)
1347 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
1350 int jtag_check_value(u8 *captured, void *priv, scan_field_t *field)
1352 int retval = ERROR_OK;
1353 int num_bits = field->num_bits;
1355 int compare_failed = 0;
1357 if (field->in_check_mask)
1358 compare_failed = buf_cmp_mask(captured, field->in_check_value, field->in_check_mask, num_bits);
1360 compare_failed = buf_cmp(captured, field->in_check_value, num_bits);
1362 if (compare_failed){
1363 /* An error handler could have caught the failing check
1364 * only report a problem when there wasn't a handler, or if the handler
1365 * acknowledged the error
1367 LOG_WARNING("TAP %s:",
1368 jtag_tap_name(field->tap));
1371 char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1372 char *in_check_value_char = buf_to_str(field->in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1374 if (field->in_check_mask)
1376 char *in_check_mask_char;
1377 in_check_mask_char = buf_to_str(field->in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1378 LOG_WARNING("value captured during scan didn't pass the requested check:");
1379 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1380 captured_char, in_check_value_char, in_check_mask_char);
1381 free(in_check_mask_char);
1385 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);
1388 free(captured_char);
1389 free(in_check_value_char);
1391 retval = ERROR_JTAG_QUEUE_FAILED;
1399 set up checking of this field using the in_handler. The values passed in must be valid until
1400 after jtag_execute() has completed.
1402 void jtag_set_check_value(scan_field_t *field, u8 *value, u8 *mask, error_handler_t *in_error_handler)
1405 field->in_handler = jtag_check_value;
1407 field->in_handler = NULL; /* No check, e.g. embeddedice uses value==NULL to indicate no check */
1408 field->in_handler_priv = NULL;
1409 field->in_check_value = value;
1410 field->in_check_mask = mask;
1413 enum scan_type jtag_scan_type(scan_command_t *cmd)
1418 for (i = 0; i < cmd->num_fields; i++)
1420 if (cmd->fields[i].in_value || cmd->fields[i].in_handler)
1422 if (cmd->fields[i].out_value)
1429 int MINIDRIVER(interface_jtag_execute_queue)(void)
1435 LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
1439 retval = jtag->execute_queue();
1443 jtag_command_queue = NULL;
1444 last_comand_pointer = &jtag_command_queue;
1449 void jtag_execute_queue_noclear(void)
1451 int retval=interface_jtag_execute_queue();
1452 /* we keep the first error */
1453 if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
1459 int jtag_execute_queue(void)
1462 jtag_execute_queue_noclear();
1464 jtag_error=ERROR_OK;
1468 int jtag_reset_callback(enum jtag_event event, void *priv)
1470 jtag_tap_t *tap = priv;
1474 if (event == JTAG_TRST_ASSERTED)
1476 buf_set_ones(tap->cur_instr, tap->ir_length);
1483 void jtag_sleep(u32 us)
1485 alive_sleep(us/1000);
1488 /* Try to examine chain layout according to IEEE 1149.1 §12
1490 int jtag_examine_chain(void)
1494 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1497 int device_count = 0;
1498 u8 zero_check = 0x0;
1499 u8 one_check = 0xff;
1502 field.num_bits = sizeof(idcode_buffer) * 8;
1503 field.out_value = idcode_buffer;
1505 field.in_value = idcode_buffer;
1508 field.in_handler = NULL;
1510 for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1512 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1515 jtag_add_plain_dr_scan(1, &field, TAP_RESET);
1516 jtag_execute_queue();
1518 for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1520 zero_check |= idcode_buffer[i];
1521 one_check &= idcode_buffer[i];
1524 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1525 if ((zero_check == 0x00) || (one_check == 0xff))
1527 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1528 return ERROR_JTAG_INIT_FAILED;
1531 /* point at the 1st tap */
1532 tap = jtag_NextEnabledTap(NULL);
1534 LOG_ERROR("JTAG: No taps enabled?");
1535 return ERROR_JTAG_INIT_FAILED;
1538 for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1540 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1541 if ((idcode & 1) == 0)
1543 /* LSB must not be 0, this indicates a device in bypass */
1544 LOG_WARNING("Tap/Device does not have IDCODE");
1555 /* some devices, such as AVR will output all 1's instead of TDI
1556 input value at end of chain. */
1557 if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1560 /* End of chain (invalid manufacturer ID)
1562 * The JTAG examine is the very first thing that happens
1564 * A single JTAG device requires only 64 bits to be read back correctly.
1566 * The code below adds a check that the rest of the data scanned (640 bits)
1567 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1569 * earlier and gives more helpful/explicit error messages.
1571 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1573 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1574 if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1576 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1584 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1585 manufacturer = EXTRACT_MFG(idcode);
1586 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1587 part = EXTRACT_PART(idcode);
1588 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1589 version = EXTRACT_VER(idcode);
1591 LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1592 ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1593 idcode, manufacturer, part, version);
1599 tap->idcode = idcode;
1601 if (tap->expected_ids_cnt > 0) {
1602 /* Loop over the expected identification codes and test for a match */
1604 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1605 if( tap->idcode == tap->expected_ids[ii] ){
1610 /* If none of the expected ids matched, log an error */
1611 if (ii == tap->expected_ids_cnt) {
1612 LOG_ERROR("JTAG tap: %s got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1615 EXTRACT_MFG( tap->idcode ),
1616 EXTRACT_PART( tap->idcode ),
1617 EXTRACT_VER( tap->idcode ) );
1618 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1619 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1622 tap->expected_ids_cnt,
1623 tap->expected_ids[ii],
1624 EXTRACT_MFG( tap->expected_ids[ii] ),
1625 EXTRACT_PART( tap->expected_ids[ii] ),
1626 EXTRACT_VER( tap->expected_ids[ii] ) );
1629 return ERROR_JTAG_INIT_FAILED;
1631 LOG_INFO("JTAG Tap/device matched");
1635 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1639 tap = jtag_NextEnabledTap(tap);
1644 /* see if number of discovered devices matches configuration */
1645 if (device_count != jtag_NumEnabledTaps())
1647 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1648 device_count, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1649 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1650 return ERROR_JTAG_INIT_FAILED;
1656 int jtag_validate_chain(void)
1659 int total_ir_length = 0;
1665 total_ir_length = 0;
1667 tap = jtag_NextEnabledTap(tap);
1671 total_ir_length += tap->ir_length;
1674 total_ir_length += 2;
1675 ir_test = malloc(CEIL(total_ir_length, 8));
1676 buf_set_ones(ir_test, total_ir_length);
1679 field.num_bits = total_ir_length;
1680 field.out_value = ir_test;
1681 field.in_value = ir_test;
1682 field.in_handler = NULL;
1684 jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1685 jtag_execute_queue();
1691 tap = jtag_NextEnabledTap(tap);
1696 val = buf_get_u32(ir_test, chain_pos, 2);
1699 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1700 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);
1703 return ERROR_JTAG_INIT_FAILED;
1705 chain_pos += tap->ir_length;
1708 val = buf_get_u32(ir_test, chain_pos, 2);
1711 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1712 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);
1715 return ERROR_JTAG_INIT_FAILED;
1723 enum jtag_tap_cfg_param {
1727 static Jim_Nvp nvp_config_opts[] = {
1728 { .name = "-event", .value = JCFG_EVENT },
1730 { .name = NULL, .value = -1 }
1733 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1739 /* parse config or cget options */
1740 while (goi->argc > 0) {
1741 Jim_SetEmptyResult (goi->interp);
1743 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1745 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1751 if (goi->argc == 0) {
1752 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1756 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1758 Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1762 if (goi->isconfigure) {
1763 if (goi->argc != 1) {
1764 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1768 if (goi->argc != 0) {
1769 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1775 jtag_tap_event_action_t *jteap;
1777 jteap = tap->event_action;
1778 /* replace existing? */
1780 if (jteap->event == (enum jtag_tap_event)n->value) {
1783 jteap = jteap->next;
1786 if (goi->isconfigure) {
1787 if (jteap == NULL) {
1789 jteap = calloc(1, sizeof (*jteap));
1791 jteap->event = n->value;
1792 Jim_GetOpt_Obj( goi, &o);
1794 Jim_DecrRefCount(interp, jteap->body);
1796 jteap->body = Jim_DuplicateObj(goi->interp, o);
1797 Jim_IncrRefCount(jteap->body);
1799 /* add to head of event list */
1800 jteap->next = tap->event_action;
1801 tap->event_action = jteap;
1802 Jim_SetEmptyResult(goi->interp);
1805 if (jteap == NULL) {
1806 Jim_SetEmptyResult(goi->interp);
1808 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1815 } /* while (goi->argc) */
1820 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1830 const Jim_Nvp opts[] = {
1831 #define NTAP_OPT_IRLEN 0
1832 { .name = "-irlen" , .value = NTAP_OPT_IRLEN },
1833 #define NTAP_OPT_IRMASK 1
1834 { .name = "-irmask" , .value = NTAP_OPT_IRMASK },
1835 #define NTAP_OPT_IRCAPTURE 2
1836 { .name = "-ircapture" , .value = NTAP_OPT_IRCAPTURE },
1837 #define NTAP_OPT_ENABLED 3
1838 { .name = "-enable" , .value = NTAP_OPT_ENABLED },
1839 #define NTAP_OPT_DISABLED 4
1840 { .name = "-disable" , .value = NTAP_OPT_DISABLED },
1841 #define NTAP_OPT_EXPECTED_ID 5
1842 { .name = "-expected-id" , .value = NTAP_OPT_EXPECTED_ID },
1843 { .name = NULL , .value = -1 },
1846 pTap = malloc( sizeof(jtag_tap_t) );
1847 memset( pTap, 0, sizeof(*pTap) );
1849 Jim_SetResult_sprintf( goi->interp, "no memory");
1853 * we expect CHIP + TAP + OPTIONS
1855 if( goi->argc < 3 ){
1856 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
1859 Jim_GetOpt_String( goi, &cp, NULL );
1860 pTap->chip = strdup(cp);
1862 Jim_GetOpt_String( goi, &cp, NULL );
1863 pTap->tapname = strdup(cp);
1865 /* name + dot + name + null */
1866 x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
1868 sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
1869 pTap->dotted_name = cp;
1871 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1872 pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
1874 /* default is enabled */
1877 /* deal with options */
1878 #define NTREQ_IRLEN 1
1879 #define NTREQ_IRCAPTURE 2
1880 #define NTREQ_IRMASK 4
1882 /* clear them as we find them */
1883 reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
1886 e = Jim_GetOpt_Nvp( goi, opts, &n );
1888 Jim_GetOpt_NvpUnknown( goi, opts, 0 );
1891 LOG_DEBUG("Processing option: %s", n->name );
1893 case NTAP_OPT_ENABLED:
1896 case NTAP_OPT_DISABLED:
1899 case NTAP_OPT_EXPECTED_ID:
1901 u32 *new_expected_ids;
1903 e = Jim_GetOpt_Wide( goi, &w );
1905 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
1909 new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
1910 if (new_expected_ids == NULL) {
1911 Jim_SetResult_sprintf( goi->interp, "no memory");
1915 memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
1917 new_expected_ids[pTap->expected_ids_cnt] = w;
1919 free(pTap->expected_ids);
1920 pTap->expected_ids = new_expected_ids;
1921 pTap->expected_ids_cnt++;
1924 case NTAP_OPT_IRLEN:
1925 case NTAP_OPT_IRMASK:
1926 case NTAP_OPT_IRCAPTURE:
1927 e = Jim_GetOpt_Wide( goi, &w );
1929 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
1932 if( (w < 0) || (w > 0xffff) ){
1934 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
1935 n->name, (int)(w), (int)(w));
1939 case NTAP_OPT_IRLEN:
1940 pTap->ir_length = w;
1941 reqbits &= (~(NTREQ_IRLEN));
1943 case NTAP_OPT_IRMASK:
1944 pTap->ir_capture_mask = w;
1945 reqbits &= (~(NTREQ_IRMASK));
1947 case NTAP_OPT_IRCAPTURE:
1948 pTap->ir_capture_value = w;
1949 reqbits &= (~(NTREQ_IRCAPTURE));
1952 } /* switch(n->value) */
1953 } /* while( goi->argc ) */
1955 /* Did we get all the options? */
1958 Jim_SetResult_sprintf( goi->interp,
1959 "newtap: %s missing required parameters",
1961 /* TODO: Tell user what is missing :-( */
1962 /* no memory leaks pelase */
1963 free(((void *)(pTap->expected_ids)));
1964 free(((void *)(pTap->chip)));
1965 free(((void *)(pTap->tapname)));
1966 free(((void *)(pTap->dotted_name)));
1967 free(((void *)(pTap)));
1971 pTap->expected = malloc( pTap->ir_length );
1972 pTap->expected_mask = malloc( pTap->ir_length );
1973 pTap->cur_instr = malloc( pTap->ir_length );
1975 buf_set_u32( pTap->expected,
1978 pTap->ir_capture_value );
1979 buf_set_u32( pTap->expected_mask,
1982 pTap->ir_capture_mask );
1983 buf_set_ones( pTap->cur_instr,
1988 jtag_register_event_callback(jtag_reset_callback, pTap );
1990 ppTap = &(jtag_all_taps);
1991 while( (*ppTap) != NULL ){
1992 ppTap = &((*ppTap)->next_tap);
1996 static int n_taps = 0;
1997 pTap->abs_chain_position = n_taps++;
1999 LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
2000 (*ppTap)->dotted_name,
2001 (*ppTap)->abs_chain_position,
2002 (*ppTap)->ir_length,
2003 (*ppTap)->ir_capture_value,
2004 (*ppTap)->ir_capture_mask );
2009 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
2015 struct command_context_s *context;
2019 JTAG_CMD_INIT_RESET,
2022 JTAG_CMD_TAPDISABLE,
2023 JTAG_CMD_TAPISENABLED,
2028 const Jim_Nvp jtag_cmds[] = {
2029 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
2030 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
2031 { .name = "newtap" , .value = JTAG_CMD_NEWTAP },
2032 { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED },
2033 { .name = "tapenable" , .value = JTAG_CMD_TAPENABLE },
2034 { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE },
2035 { .name = "configure" , .value = JTAG_CMD_CONFIGURE },
2036 { .name = "cget" , .value = JTAG_CMD_CGET },
2038 { .name = NULL, .value = -1 },
2041 context = Jim_GetAssocData(interp, "context");
2042 /* go past the command */
2043 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
2045 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
2047 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
2050 Jim_SetEmptyResult( goi.interp );
2052 case JTAG_CMD_INTERFACE:
2053 /* return the name of the interface */
2054 /* TCL code might need to know the exact type... */
2055 /* FUTURE: we allow this as a means to "set" the interface. */
2056 if( goi.argc != 0 ){
2057 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2060 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
2062 case JTAG_CMD_INIT_RESET:
2063 if( goi.argc != 0 ){
2064 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2067 e = jtag_init_reset(context);
2068 if( e != ERROR_OK ){
2069 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
2073 case JTAG_CMD_NEWTAP:
2074 return jim_newtap_cmd( &goi );
2076 case JTAG_CMD_TAPISENABLED:
2077 case JTAG_CMD_TAPENABLE:
2078 case JTAG_CMD_TAPDISABLE:
2079 if( goi.argc != 1 ){
2080 Jim_SetResultString( goi.interp, "Too many parameters",-1 );
2086 t = jtag_TapByJimObj( goi.interp, goi.argv[0] );
2091 case JTAG_CMD_TAPISENABLED:
2094 case JTAG_CMD_TAPENABLE:
2095 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
2099 case JTAG_CMD_TAPDISABLE:
2100 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
2105 Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
2112 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
2119 Jim_GetOpt_Obj(&goi, &o);
2120 t = jtag_TapByJimObj( goi.interp, o );
2125 goi.isconfigure = 0;
2126 return jtag_tap_configure_cmd( &goi, t);
2130 case JTAG_CMD_CONFIGURE:
2132 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
2139 Jim_GetOpt_Obj(&goi, &o);
2140 t = jtag_TapByJimObj( goi.interp, o );
2145 goi.isconfigure = 1;
2146 return jtag_tap_configure_cmd( &goi, t);
2153 int jtag_register_commands(struct command_context_s *cmd_ctx)
2155 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
2157 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
2158 COMMAND_CONFIG, "try to configure interface");
2159 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
2160 COMMAND_ANY, "set jtag speed (if supported)");
2161 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
2162 COMMAND_ANY, "same as jtag_speed, except it takes maximum khz as arguments. 0 KHz = RTCK.");
2163 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
2164 COMMAND_CONFIG, "jtag_device <ir_length> <ir_expected> <ir_mask>");
2165 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
2167 "[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]");
2168 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
2169 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
2170 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
2171 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
2173 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
2174 COMMAND_EXEC, "print current scan chain configuration");
2176 register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
2177 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
2178 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
2179 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
2180 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
2181 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
2182 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
2183 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
2184 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
2186 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
2187 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
2191 int jtag_interface_init(struct command_context_s *cmd_ctx)
2196 if (!jtag_interface)
2198 /* nothing was previously specified by "interface" command */
2199 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
2200 return ERROR_JTAG_INVALID_INTERFACE;
2204 jtag_interface->khz(speed_khz, &jtag_speed);
2208 if (jtag_interface->init() != ERROR_OK)
2209 return ERROR_JTAG_INIT_FAILED;
2211 jtag = jtag_interface;
2215 static int jtag_init_inner(struct command_context_s *cmd_ctx)
2220 LOG_DEBUG("Init JTAG chain");
2222 tap = jtag_NextEnabledTap(NULL);
2224 LOG_ERROR("There are no enabled taps?");
2225 return ERROR_JTAG_INIT_FAILED;
2229 if ((retval=jtag_execute_queue())!=ERROR_OK)
2232 /* examine chain first, as this could discover the real chain layout */
2233 if (jtag_examine_chain() != ERROR_OK)
2235 LOG_ERROR("trying to validate configured JTAG chain anyway...");
2238 if (jtag_validate_chain() != ERROR_OK)
2240 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
2246 int jtag_init_reset(struct command_context_s *cmd_ctx)
2250 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2253 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
2255 /* Reset can happen after a power cycle.
2257 * Ideally we would only assert TRST or run RESET before the target reset.
2259 * However w/srst_pulls_trst, trst is asserted together with the target
2260 * reset whether we want it or not.
2262 * NB! Some targets have JTAG circuitry disabled until a
2263 * trst & srst has been asserted.
2265 * NB! here we assume nsrst/ntrst delay are sufficient!
2267 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
2270 jtag_add_reset(1, 0); /* RESET or TRST */
2271 if (jtag_reset_config & RESET_HAS_SRST)
2273 jtag_add_reset(1, 1);
2274 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
2275 jtag_add_reset(0, 1);
2277 jtag_add_reset(0, 0);
2278 if ((retval = jtag_execute_queue()) != ERROR_OK)
2281 /* Check that we can communication on the JTAG chain + eventually we want to
2282 * be able to perform enumeration only after OpenOCD has started
2283 * telnet and GDB server
2285 * That would allow users to more easily perform any magic they need to before
2288 return jtag_init_inner(cmd_ctx);
2291 int jtag_init(struct command_context_s *cmd_ctx)
2294 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2296 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
2300 return jtag_init_reset(cmd_ctx);
2303 static int default_khz(int khz, int *jtag_speed)
2305 LOG_ERROR("Translation from khz to jtag_speed not implemented");
2309 static int default_speed_div(int speed, int *khz)
2311 LOG_ERROR("Translation from jtag_speed to khz not implemented");
2315 static int default_power_dropout(int *dropout)
2317 *dropout=0; /* by default we can't detect power dropout */
2321 static int default_srst_asserted(int *srst_asserted)
2323 *srst_asserted=0; /* by default we can't detect srst asserted */
2327 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2332 /* check whether the interface is already configured */
2335 LOG_WARNING("Interface already configured, ignoring");
2339 /* interface name is a mandatory argument */
2340 if (argc < 1 || args[0][0] == '\0')
2342 return ERROR_COMMAND_SYNTAX_ERROR;
2345 for (i=0; jtag_interfaces[i]; i++)
2347 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
2349 if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
2354 jtag_interface = jtag_interfaces[i];
2356 if (jtag_interface->khz == NULL)
2358 jtag_interface->khz = default_khz;
2360 if (jtag_interface->speed_div == NULL)
2362 jtag_interface->speed_div = default_speed_div;
2364 if (jtag_interface->power_dropout == NULL)
2366 jtag_interface->power_dropout = default_power_dropout;
2368 if (jtag_interface->srst_asserted == NULL)
2370 jtag_interface->srst_asserted = default_srst_asserted;
2377 /* no valid interface was found (i.e. the configuration option,
2378 * didn't match one of the compiled-in interfaces
2380 LOG_ERROR("No valid jtag interface found (%s)", args[0]);
2381 LOG_ERROR("compiled-in jtag interfaces:");
2382 for (i = 0; jtag_interfaces[i]; i++)
2384 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
2387 return ERROR_JTAG_INVALID_INTERFACE;
2390 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2394 Jim_Obj *newargs[ 10 ];
2397 * argv[-1] = command
2398 * argv[ 0] = ir length
2399 * argv[ 1] = ir capture
2400 * argv[ 2] = ir mask
2401 * argv[ 3] = not actually used by anything but in the docs
2405 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2408 command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2409 command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2413 command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2414 command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2415 command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2416 command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
2418 newargs[0] = Jim_NewStringObj( interp, "jtag", -1 );
2419 newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
2420 sprintf( buf, "chip%d", jtag_NumTotalTaps() );
2421 newargs[2] = Jim_NewStringObj( interp, buf, -1 );
2422 sprintf( buf, "tap%d", jtag_NumTotalTaps() );
2423 newargs[3] = Jim_NewStringObj( interp, buf, -1 );
2424 newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 );
2425 newargs[5] = Jim_NewStringObj( interp, args[0], -1 );
2426 newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 );
2427 newargs[7] = Jim_NewStringObj( interp, args[1], -1 );
2428 newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 );
2429 newargs[9] = Jim_NewStringObj( interp, args[2], -1 );
2431 command_print( cmd_ctx, "NEW COMMAND:");
2432 sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
2433 Jim_GetString( newargs[0], NULL ),
2434 Jim_GetString( newargs[1], NULL ),
2435 Jim_GetString( newargs[2], NULL ),
2436 Jim_GetString( newargs[3], NULL ),
2437 Jim_GetString( newargs[4], NULL ),
2438 Jim_GetString( newargs[5], NULL ),
2439 Jim_GetString( newargs[6], NULL ),
2440 Jim_GetString( newargs[7], NULL ),
2441 Jim_GetString( newargs[8], NULL ),
2442 Jim_GetString( newargs[9], NULL ) );
2444 e = jim_jtag_command( interp, 10, newargs );
2446 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
2451 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2455 tap = jtag_all_taps;
2456 command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
2457 command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
2460 u32 expected, expected_mask, cur_instr, ii;
2461 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
2462 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
2463 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
2465 command_print(cmd_ctx,
2466 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2467 tap->abs_chain_position,
2469 tap->enabled ? 'Y' : 'n',
2471 (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
2477 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
2478 command_print(cmd_ctx, " | | | | 0x%08x | | | | ",
2479 tap->expected_ids[ii]);
2482 tap = tap->next_tap;
2488 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2491 return ERROR_COMMAND_SYNTAX_ERROR;
2495 if (strcmp(args[0], "none") == 0)
2496 jtag_reset_config = RESET_NONE;
2497 else if (strcmp(args[0], "trst_only") == 0)
2498 jtag_reset_config = RESET_HAS_TRST;
2499 else if (strcmp(args[0], "srst_only") == 0)
2500 jtag_reset_config = RESET_HAS_SRST;
2501 else if (strcmp(args[0], "trst_and_srst") == 0)
2502 jtag_reset_config = RESET_TRST_AND_SRST;
2505 LOG_ERROR("(1) invalid reset_config argument (%s), defaulting to none", args[0]);
2506 jtag_reset_config = RESET_NONE;
2507 return ERROR_INVALID_ARGUMENTS;
2513 if (strcmp(args[1], "separate") == 0)
2515 /* seperate reset lines - default */
2518 if (strcmp(args[1], "srst_pulls_trst") == 0)
2519 jtag_reset_config |= RESET_SRST_PULLS_TRST;
2520 else if (strcmp(args[1], "trst_pulls_srst") == 0)
2521 jtag_reset_config |= RESET_TRST_PULLS_SRST;
2522 else if (strcmp(args[1], "combined") == 0)
2523 jtag_reset_config |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2526 LOG_ERROR("(2) invalid reset_config argument (%s), defaulting to none", args[1]);
2527 jtag_reset_config = RESET_NONE;
2528 return ERROR_INVALID_ARGUMENTS;
2535 if (strcmp(args[2], "trst_open_drain") == 0)
2536 jtag_reset_config |= RESET_TRST_OPEN_DRAIN;
2537 else if (strcmp(args[2], "trst_push_pull") == 0)
2538 jtag_reset_config &= ~RESET_TRST_OPEN_DRAIN;
2541 LOG_ERROR("(3) invalid reset_config argument (%s) defaulting to none", args[2] );
2542 jtag_reset_config = RESET_NONE;
2543 return ERROR_INVALID_ARGUMENTS;
2549 if (strcmp(args[3], "srst_push_pull") == 0)
2550 jtag_reset_config |= RESET_SRST_PUSH_PULL;
2551 else if (strcmp(args[3], "srst_open_drain") == 0)
2552 jtag_reset_config &= ~RESET_SRST_PUSH_PULL;
2555 LOG_ERROR("(4) invalid reset_config argument (%s), defaulting to none", args[3]);
2556 jtag_reset_config = RESET_NONE;
2557 return ERROR_INVALID_ARGUMENTS;
2564 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2568 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2573 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
2579 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2583 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2588 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
2594 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2596 int retval=ERROR_OK;
2600 LOG_DEBUG("handle jtag speed");
2603 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2605 /* this command can be called during CONFIG,
2606 * in which case jtag isn't initialized */
2609 retval=jtag->speed(cur_speed);
2611 } else if (argc == 0)
2615 return ERROR_COMMAND_SYNTAX_ERROR;
2617 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2622 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2624 int retval=ERROR_OK;
2625 LOG_DEBUG("handle jtag khz");
2629 speed_khz = strtoul(args[0], NULL, 0);
2633 LOG_DEBUG("have interface set up");
2635 if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
2641 cur_speed = jtag_speed = speed_div1;
2643 retval=jtag->speed(cur_speed);
2652 return ERROR_COMMAND_SYNTAX_ERROR;
2657 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
2663 command_print(cmd_ctx, "RCLK - adaptive");
2666 command_print(cmd_ctx, "%d kHz", speed_khz);
2672 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2678 return ERROR_COMMAND_SYNTAX_ERROR;
2682 state = tap_state_by_name( args[0] );
2684 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2685 return ERROR_COMMAND_SYNTAX_ERROR;
2687 jtag_add_end_state(state);
2688 jtag_execute_queue();
2690 command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
2695 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2702 return ERROR_COMMAND_SYNTAX_ERROR;
2705 if (args[0][0] == '1')
2707 else if (args[0][0] == '0')
2711 return ERROR_COMMAND_SYNTAX_ERROR;
2714 if (args[1][0] == '1')
2716 else if (args[1][0] == '0')
2720 return ERROR_COMMAND_SYNTAX_ERROR;
2723 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2724 return ERROR_JTAG_INIT_FAILED;
2726 jtag_add_reset(trst, srst);
2727 jtag_execute_queue();
2732 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2736 return ERROR_COMMAND_SYNTAX_ERROR;
2739 jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
2740 jtag_execute_queue();
2746 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2749 scan_field_t *fields;
2751 tap_state_t endstate;
2753 if ((argc < 2) || (argc % 2))
2755 return ERROR_COMMAND_SYNTAX_ERROR;
2758 /* optional "-endstate" */
2760 /* at the end of the arguments. */
2762 endstate = TAP_INVALID;
2764 /* have at least one pair of numbers. */
2765 /* is last pair the magic text? */
2766 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2769 cpA = args[ argc-1 ];
2770 for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2771 cpS = tap_state_name( endstate );
2772 if( 0 == strcmp( cpA, cpS ) ){
2776 if( endstate >= TAP_NUM_STATES ){
2777 return ERROR_COMMAND_SYNTAX_ERROR;
2779 /* found - remove the last 2 args */
2785 fields = malloc(sizeof(scan_field_t) * argc / 2);
2787 for (i = 0; i < argc / 2; i++)
2789 tap = jtag_TapByString( args[i*2] );
2792 command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2795 int field_size = tap->ir_length;
2796 fields[i].tap = tap;
2797 fields[i].out_value = malloc(CEIL(field_size, 8));
2798 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2799 fields[i].in_value = NULL;
2800 fields[i].in_check_mask = NULL;
2801 fields[i].in_handler = NULL;
2802 fields[i].in_handler_priv = NULL;
2805 jtag_add_ir_scan(argc / 2, fields, TAP_INVALID);
2806 /* did we have an endstate? */
2807 if (endstate != TAP_INVALID)
2808 jtag_add_end_state(endstate);
2810 jtag_execute_queue();
2812 for (i = 0; i < argc / 2; i++)
2813 free(fields[i].out_value);
2820 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2823 scan_field_t *fields;
2825 int field_count = 0;
2828 tap_state_t endstate;
2831 * args[2] = num_bits
2832 * args[3] = hex string
2833 * ... repeat num bits and hex string ...
2836 * args[N-2] = "-endstate"
2837 * args[N-1] = statename
2839 if ((argc < 4) || ((argc % 2)!=0))
2841 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2845 /* assume no endstate */
2846 endstate = TAP_INVALID;
2847 /* validate arguments as numbers */
2849 for (i = 2; i < argc; i+=2)
2854 e = Jim_GetLong(interp, args[i], &bits);
2855 /* If valid - try next arg */
2860 /* Not valid.. are we at the end? */
2861 if ( ((i+2) != argc) ){
2862 /* nope, then error */
2866 /* it could be: "-endstate FOO" */
2868 /* get arg as a string. */
2869 cp = Jim_GetString( args[i], NULL );
2870 /* is it the magic? */
2871 if( 0 == strcmp( "-endstate", cp ) ){
2872 /* is the statename valid? */
2873 cp = Jim_GetString( args[i+1], NULL );
2875 /* see if it is a valid state name */
2876 endstate = tap_state_by_name(cp);
2878 /* update the error message */
2879 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
2881 /* valid - so clear the error */
2883 /* and remove the last 2 args */
2888 /* Still an error? */
2890 return e; /* too bad */
2892 } /* validate args */
2894 tap = jtag_TapByJimObj( interp, args[1] );
2899 num_fields=(argc-2)/2;
2900 fields = malloc(sizeof(scan_field_t) * num_fields);
2901 for (i = 2; i < argc; i+=2)
2907 Jim_GetLong(interp, args[i], &bits);
2908 str = Jim_GetString(args[i+1], &len);
2910 fields[field_count].tap = tap;
2911 fields[field_count].num_bits = bits;
2912 fields[field_count].out_value = malloc(CEIL(bits, 8));
2913 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
2914 fields[field_count].in_value = fields[field_count].out_value;
2915 fields[field_count].in_check_mask = NULL;
2916 fields[field_count].in_check_value = NULL;
2917 fields[field_count].in_handler = NULL;
2918 fields[field_count++].in_handler_priv = NULL;
2921 jtag_add_dr_scan(num_fields, fields, TAP_INVALID);
2922 /* did we get an end state? */
2923 if (endstate != TAP_INVALID)
2924 jtag_add_end_state(endstate);
2926 retval = jtag_execute_queue();
2927 if (retval != ERROR_OK)
2929 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
2934 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
2935 for (i = 2; i < argc; i+=2)
2940 Jim_GetLong(interp, args[i], &bits);
2941 str = buf_to_str(fields[field_count].in_value, bits, 16);
2942 free(fields[field_count].out_value);
2944 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
2949 Jim_SetResult(interp, list);
2956 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2960 if (strcmp(args[0], "enable") == 0)
2962 jtag_verify_capture_ir = 1;
2964 else if (strcmp(args[0], "disable") == 0)
2966 jtag_verify_capture_ir = 0;
2969 return ERROR_COMMAND_SYNTAX_ERROR;
2971 } else if (argc != 0)
2973 return ERROR_COMMAND_SYNTAX_ERROR;
2976 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
2981 int jtag_power_dropout(int *dropout)
2983 return jtag->power_dropout(dropout);
2986 int jtag_srst_asserted(int *srst_asserted)
2988 return jtag->srst_asserted(srst_asserted);
2991 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
2993 jtag_tap_event_action_t * jteap;
2996 jteap = tap->event_action;
3000 if (jteap->event == e) {
3002 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
3005 Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
3006 Jim_GetString(jteap->body, NULL) );
3007 if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
3008 Jim_PrintErrorMessage(interp);
3012 jteap = jteap->next;
3016 LOG_DEBUG( "event %d %s - no action",
3018 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
3022 /*-----<Cable Helper API>---------------------------------------*/
3024 /* these Cable Helper API functions are all documented in the jtag.h header file,
3025 using a Doxygen format. And since Doxygen's configuration file "Doxyfile",
3026 is setup to prefer its docs in the header file, no documentation is here, for
3027 if it were, it would have to be doubly maintained.
3031 * @see tap_set_state() and tap_get_state() accessors.
3032 * Actual name is not important since accessors hide it.
3034 static tap_state_t state_follower = TAP_RESET;
3036 void tap_set_state_impl( tap_state_t new_state )
3038 /* this is the state we think the TAPs are in now, was cur_state */
3039 state_follower = new_state;
3042 tap_state_t tap_get_state()
3044 return state_follower;
3048 * @see tap_set_end_state() and tap_get_end_state() accessors.
3049 * Actual name is not important because accessors hide it.
3051 static tap_state_t end_state_follower = TAP_RESET;
3053 void tap_set_end_state( tap_state_t new_end_state )
3055 /* this is the state we think the TAPs will be in at completion of the
3056 current TAP operation, was end_state
3058 end_state_follower = new_end_state;
3061 tap_state_t tap_get_end_state()
3063 return end_state_follower;
3067 int tap_move_ndx( tap_state_t astate )
3069 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
3075 case TAP_RESET: ndx = 0; break;
3076 case TAP_DRSHIFT: ndx = 2; break;
3077 case TAP_DRPAUSE: ndx = 3; break;
3078 case TAP_IDLE: ndx = 1; break;
3079 case TAP_IRSHIFT: ndx = 4; break;
3080 case TAP_IRPAUSE: ndx = 5; break;
3082 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate) );
3090 /* tap_move[i][j]: tap movement command to go from state i to state j
3091 * 0: Test-Logic-Reset
3098 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
3105 } tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3107 /* value clocked to TMS to move from one of six stable states to another.
3108 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
3109 * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
3110 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
3111 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
3115 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
3116 * Read the bits from LSBit first to MSBit last (right-to-left).
3118 #define HEX__(n) 0x##n##LU
3121 (((x) & 0x0000000FLU)?(1<<0):0) \
3122 +(((x) & 0x000000F0LU)?(1<<1):0) \
3123 +(((x) & 0x00000F00LU)?(1<<2):0) \
3124 +(((x) & 0x0000F000LU)?(1<<3):0) \
3125 +(((x) & 0x000F0000LU)?(1<<4):0) \
3126 +(((x) & 0x00F00000LU)?(1<<5):0) \
3127 +(((x) & 0x0F000000LU)?(1<<6):0) \
3128 +(((x) & 0xF0000000LU)?(1<<7):0)
3130 #define B8(bits,count) { ((u8)B8__(HEX__(bits))), (count) }
3132 #if 0 && ((BUILD_FT2232_FTD2XX==1) || (BUILD_FT2232_LIBFTDI==1) || (BUILD_JLINK==1))
3133 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
3135 OK, I added Peter's version of the state table, and it works OK for
3136 me on MC1322x. I've recreated the jlink portion of patch with this
3137 new state table. His changes to my state table are pretty minor in
3138 terms of total transitions, but Peter feels that his version fixes
3139 some long-standing problems.
3142 I added the bit count into the table, reduced RESET column to 7 bits from 8.
3145 state specific comments:
3146 ------------------------
3147 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
3148 work better on ARM9 with ft2232 driver. (Dick)
3150 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3151 needed on ARM9 with ft2232 driver. (Dick)
3153 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3154 needed on ARM9 with ft2232 driver. (Dick)
3158 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3159 { B8(1111111,7), B8(0,1), B8(00101,5), B8(01010,5), B8(001101,6), B8(010110,6) }, /* RESET */
3160 { B8(1111111,7), B8(0,1), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
3161 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
3162 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
3163 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
3164 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
3166 #else /* this is the old table, converted from hex and with the bit_count set to 7 for each combo, like before */
3169 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3170 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3171 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
3172 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
3173 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
3174 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
3175 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0100000,7), B8(0101111,7) } /* IRPAUSE */
3179 #if 0 /* keeping old hex stuff for awhile, for reference */
3180 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */
3181 { 0x7f, 0x00, 0x17, 0x0a, 0x1b, 0x16 }, /* RESET */
3182 { 0x7f, 0x00, 0x25, 0x05, 0x2b, 0x0b }, /* IDLE */
3183 { 0x7f, 0x31, 0x00, 0x01, 0x0f, 0x2f }, /* DRSHIFT */
3184 { 0x7f, 0x30, 0x20, 0x17, 0x1e, 0x2f }, /* DRPAUSE */
3185 { 0x7f, 0x31, 0x07, 0x17, 0x00, 0x01 }, /* IRSHIFT */
3186 { 0x7f, 0x30, 0x1c, 0x17, 0x20, 0x2f } /* IRPAUSE */
3191 int tap_get_tms_path( tap_state_t from, tap_state_t to )
3193 return tms_seqs[tap_move_ndx(from)][tap_move_ndx(to)].bits;
3197 int tap_get_tms_path_len( tap_state_t from, tap_state_t to )
3199 return tms_seqs[tap_move_ndx(from)][tap_move_ndx(to)].bit_count;
3203 bool tap_is_state_stable(tap_state_t astate)
3207 /* A switch() is used because it is symbol dependent
3208 (not value dependent like an array), and can also check bounds.
3227 tap_state_t tap_state_transition(tap_state_t cur_state, bool tms)
3229 tap_state_t new_state;
3231 /* A switch is used because it is symbol dependent and not value dependent
3232 like an array. Also it can check for out of range conditions.
3240 new_state = cur_state;
3245 new_state = TAP_DRSELECT;
3248 new_state = TAP_IRSELECT;
3252 new_state = TAP_DREXIT1;
3256 new_state = TAP_DRUPDATE;
3259 new_state = TAP_DREXIT2;
3262 new_state = TAP_RESET;
3266 new_state = TAP_IREXIT1;
3270 new_state = TAP_IRUPDATE;
3273 new_state = TAP_IREXIT2;
3276 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3289 new_state = TAP_IDLE;
3292 new_state = TAP_DRCAPTURE;
3297 new_state = TAP_DRSHIFT;
3301 new_state = TAP_DRPAUSE;
3304 new_state = TAP_IRCAPTURE;
3309 new_state = TAP_IRSHIFT;
3313 new_state = TAP_IRPAUSE;
3316 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3325 const char* tap_state_name(tap_state_t state)
3331 case TAP_RESET: ret = "RESET"; break;
3332 case TAP_IDLE: ret = "RUN/IDLE"; break;
3333 case TAP_DRSELECT: ret = "DRSELECT"; break;
3334 case TAP_DRCAPTURE: ret = "DRCAPTURE"; break;
3335 case TAP_DRSHIFT: ret = "DRSHIFT"; break;
3336 case TAP_DREXIT1: ret = "DREXIT1"; break;
3337 case TAP_DRPAUSE: ret = "DRPAUSE"; break;
3338 case TAP_DREXIT2: ret = "DREXIT2"; break;
3339 case TAP_DRUPDATE: ret = "DRUPDATE"; break;
3340 case TAP_IRSELECT: ret = "IRSELECT"; break;
3341 case TAP_IRCAPTURE: ret = "IRCAPTURE"; break;
3342 case TAP_IRSHIFT: ret = "IRSHIFT"; break;
3343 case TAP_IREXIT1: ret = "IREXIT1"; break;
3344 case TAP_IRPAUSE: ret = "IRPAUSE"; break;
3345 case TAP_IREXIT2: ret = "IREXIT2"; break;
3346 case TAP_IRUPDATE: ret = "IRUPDATE"; break;
3347 default: ret = "???";
3353 static tap_state_t tap_state_by_name( const char *name )
3357 for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
3358 /* be nice to the human */
3359 if( 0 == strcasecmp( name, tap_state_name(x) ) ){
3367 #ifdef _DEBUG_JTAG_IO_
3369 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3370 do { buf[len] = bit ? '1' : '0'; } while(0)
3371 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3372 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3373 tap_state_name(a), tap_state_name(b), astr, bstr)
3375 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
3376 unsigned tap_bits, tap_state_t next_state)
3378 const u8 *tms_buffer;
3379 const u8 *tdi_buffer;
3384 unsigned tap_out_bits;
3388 tap_state_t last_state;
3390 // set startstate (and possibly last, if tap_bits == 0)
3391 last_state = next_state;
3392 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
3394 tms_buffer = (const u8 *)tms_buf;
3395 tdi_buffer = (const u8 *)tdi_buf;
3397 tap_bytes = TAP_SCAN_BYTES(tap_bits);
3398 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
3401 for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
3403 for(cur_bit = 0; cur_bit < 8; cur_bit++)
3405 // make sure we do not run off the end of the buffers
3406 unsigned tap_bit = cur_byte * 8 + cur_bit;
3407 if (tap_bit == tap_bits)
3410 // check and save TMS bit
3411 tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
3412 JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
3414 // use TMS bit to find the next TAP state
3415 next_state = tap_state_transition(last_state, tap_bit);
3417 // check and store TDI bit
3418 tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
3419 JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
3421 // increment TAP bits
3424 // Only show TDO bits on state transitions, or
3425 // after some number of bits in the same state.
3426 if ((next_state == last_state) && (tap_out_bits < 32))
3429 // terminate strings and display state transition
3430 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3431 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3434 last_state = next_state;
3441 // terminate strings and display state transition
3442 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3443 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3446 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
3450 #endif // _DEBUG_JTAG_IO_
3452 /*-----</Cable Helper API>--------------------------------------*/