1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
17 * This program is distributed in the hope that it will be useful, *
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
20 * GNU General Public License for more details. *
22 * You should have received a copy of the GNU General Public License *
23 * along with this program; if not, write to the *
24 * Free Software Foundation, Inc., *
25 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
26 ***************************************************************************/
38 int jtag_flush_queue_count; /* count # of flushes for profiling / debugging purposes */
40 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
41 int in_num_fields, scan_field_t *in_fields, tap_state_t state);
43 /* note that this is not marked as static as it must be available from outside jtag.c for those
44 that implement the jtag_xxx() minidriver layer
46 int jtag_error=ERROR_OK;
48 typedef struct cmd_queue_page_s
52 struct cmd_queue_page_s *next;
55 #define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
56 static cmd_queue_page_t *cmd_queue_pages = NULL;
58 char* jtag_event_strings[] =
60 "JTAG controller reset (RESET or TRST)"
63 const Jim_Nvp nvp_jtag_tap_event[] = {
64 { .value = JTAG_TAP_EVENT_ENABLE, .name = "tap-enable" },
65 { .value = JTAG_TAP_EVENT_DISABLE, .name = "tap-disable" },
67 { .name = NULL, .value = -1 }
73 #ifndef HAVE_JTAG_MINIDRIVER_H
74 struct jtag_callback_entry
76 struct jtag_callback_entry *next;
78 jtag_callback_t callback;
80 jtag_callback_data_t data1;
81 jtag_callback_data_t data2;
82 jtag_callback_data_t data3;
86 static struct jtag_callback_entry *jtag_callback_queue_head = NULL;
87 static struct jtag_callback_entry *jtag_callback_queue_tail = NULL;
91 jtag_command_t *jtag_command_queue = NULL;
92 jtag_command_t **last_command_pointer = &jtag_command_queue;
93 static jtag_tap_t *jtag_all_taps = NULL;
95 enum reset_types jtag_reset_config = RESET_NONE;
96 tap_state_t cmd_queue_end_state = TAP_RESET;
97 tap_state_t cmd_queue_cur_state = TAP_RESET;
99 int jtag_verify_capture_ir = 1;
102 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
103 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
104 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
106 /* maximum number of JTAG devices expected in the chain
108 #define JTAG_MAX_CHAIN_SIZE 20
110 /* callbacks to inform high-level handlers about JTAG state changes */
111 jtag_event_callback_t *jtag_event_callbacks;
114 static int speed_khz = 0;
115 /* flag if the kHz speed was defined */
116 static int hasKHz = 0;
118 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
121 #if BUILD_ECOSBOARD == 1
122 extern jtag_interface_t zy1000_interface;
125 #if BUILD_PARPORT == 1
126 extern jtag_interface_t parport_interface;
130 extern jtag_interface_t dummy_interface;
133 #if BUILD_FT2232_FTD2XX == 1
134 extern jtag_interface_t ft2232_interface;
137 #if BUILD_FT2232_LIBFTDI == 1
138 extern jtag_interface_t ft2232_interface;
141 #if BUILD_AMTJTAGACCEL == 1
142 extern jtag_interface_t amt_jtagaccel_interface;
145 #if BUILD_EP93XX == 1
146 extern jtag_interface_t ep93xx_interface;
149 #if BUILD_AT91RM9200 == 1
150 extern jtag_interface_t at91rm9200_interface;
153 #if BUILD_GW16012 == 1
154 extern jtag_interface_t gw16012_interface;
157 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
158 extern jtag_interface_t presto_interface;
161 #if BUILD_USBPROG == 1
162 extern jtag_interface_t usbprog_interface;
166 extern jtag_interface_t jlink_interface;
169 #if BUILD_VSLLINK == 1
170 extern jtag_interface_t vsllink_interface;
174 extern jtag_interface_t rlink_interface;
177 #if BUILD_ARMJTAGEW == 1
178 extern jtag_interface_t armjtagew_interface;
181 jtag_interface_t *jtag_interfaces[] = {
182 #if BUILD_ECOSBOARD == 1
185 #if BUILD_PARPORT == 1
191 #if BUILD_FT2232_FTD2XX == 1
194 #if BUILD_FT2232_LIBFTDI == 1
197 #if BUILD_AMTJTAGACCEL == 1
198 &amt_jtagaccel_interface,
200 #if BUILD_EP93XX == 1
203 #if BUILD_AT91RM9200 == 1
204 &at91rm9200_interface,
206 #if BUILD_GW16012 == 1
209 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
212 #if BUILD_USBPROG == 1
218 #if BUILD_VSLLINK == 1
224 #if BUILD_ARMJTAGEW == 1
225 &armjtagew_interface,
230 jtag_interface_t *jtag = NULL;
233 static jtag_interface_t *jtag_interface = NULL;
236 /* forward declarations */
237 //void jtag_add_pathmove(int num_states, tap_state_t *path);
238 //void jtag_add_runtest(int num_cycles, tap_state_t endstate);
239 //void jtag_add_end_state(tap_state_t endstate);
240 //void jtag_add_sleep(u32 us);
241 //int jtag_execute_queue(void);
242 static tap_state_t tap_state_by_name(const char *name);
245 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
246 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
247 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
248 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
249 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
250 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
251 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
253 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
255 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
256 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
257 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
258 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
259 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
260 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args);
262 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
263 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
264 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
266 jtag_tap_t *jtag_AllTaps(void)
268 return jtag_all_taps;
271 int jtag_NumTotalTaps(void)
285 int jtag_NumEnabledTaps(void)
301 jtag_tap_t *jtag_TapByString( const char *s )
309 if( 0 == strcmp( t->dotted_name, s ) ){
315 /* backup plan is by number */
317 /* ok - is "s" a number? */
319 n = strtol( s, &cp, 0 );
320 if( (s != cp) && (*cp == 0) ){
322 t = jtag_TapByAbsPosition(n);
328 jtag_tap_t * jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *o )
333 cp = Jim_GetString( o, NULL );
338 t = jtag_TapByString( cp );
341 Jim_SetResult_sprintf(interp,"Tap: %s is unknown", cp );
346 /* returns a pointer to the n-th device in the scan chain */
347 jtag_tap_t * jtag_TapByAbsPosition( int n )
355 while( t && (n > 0)) {
362 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
364 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
366 if (callback == NULL)
368 return ERROR_INVALID_ARGUMENTS;
373 while ((*callbacks_p)->next)
374 callbacks_p = &((*callbacks_p)->next);
375 callbacks_p = &((*callbacks_p)->next);
378 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
379 (*callbacks_p)->callback = callback;
380 (*callbacks_p)->priv = priv;
381 (*callbacks_p)->next = NULL;
386 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
388 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
390 if (callback == NULL)
392 return ERROR_INVALID_ARGUMENTS;
397 jtag_event_callback_t **next = &((*callbacks_p)->next);
398 if ((*callbacks_p)->callback == callback)
401 *callbacks_p = *next;
409 int jtag_call_event_callbacks(enum jtag_event event)
411 jtag_event_callback_t *callback = jtag_event_callbacks;
413 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
417 callback->callback(event, callback->priv);
418 callback = callback->next;
424 /* returns a pointer to the pointer of the last command in queue
425 * this may be a pointer to the root pointer (jtag_command_queue)
426 * or to the next member of the last but one command
428 jtag_command_t** jtag_get_last_command_p(void)
430 /* jtag_command_t *cmd = jtag_command_queue;
436 return &jtag_command_queue;
440 return last_command_pointer;
444 void jtag_queue_command(jtag_command_t * cmd)
446 jtag_command_t **last_cmd;
448 last_cmd = jtag_get_last_command_p();
452 (*last_cmd)->next = NULL;
454 last_command_pointer = &((*last_cmd)->next);
458 void* cmd_queue_alloc(size_t size)
460 cmd_queue_page_t **p_page = &cmd_queue_pages;
466 * We align/round the *SIZE* per below
467 * so that all pointers returned by
468 * this function are reasonably well
471 * If we did not, then an "odd-length" request would cause the
472 * *next* allocation to be at an *odd* address, and because
473 * this function has the same type of api as malloc() - we
474 * must also return pointers that have the same type of
477 * What I do not/have is a reasonable portable means
480 * The solution here, is based on these suggestions.
481 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
484 union worse_case_align {
490 #define ALIGN_SIZE (sizeof(union worse_case_align))
492 /* The alignment process. */
493 size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
498 while ((*p_page)->next)
499 p_page = &((*p_page)->next);
500 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
501 p_page = &((*p_page)->next);
506 *p_page = malloc(sizeof(cmd_queue_page_t));
508 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
509 (*p_page)->next = NULL;
512 offset = (*p_page)->used;
513 (*p_page)->used += size;
515 t=(u8 *)((*p_page)->address);
519 void cmd_queue_free(void)
521 cmd_queue_page_t *page = cmd_queue_pages;
525 cmd_queue_page_t *last = page;
531 cmd_queue_pages = NULL;
535 * Copy a scan_field_t for insertion into the queue.
537 * This allocates a new copy of out_value using cmd_queue_alloc.
539 static void cmd_queue_scan_field_clone(scan_field_t * dst, const scan_field_t * src)
542 dst->num_bits = src->num_bits;
543 dst->out_value = buf_cpy(src->out_value, cmd_queue_alloc(CEIL(src->num_bits, 8)), src->num_bits);
544 dst->in_value = src->in_value;
548 static void jtag_prelude1(void)
552 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
553 jtag_error=ERROR_JTAG_TRST_ASSERTED;
557 if (cmd_queue_end_state == TAP_RESET)
558 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
561 static void jtag_prelude(tap_state_t state)
565 if (state != TAP_INVALID)
566 jtag_add_end_state(state);
568 cmd_queue_cur_state = cmd_queue_end_state;
571 void jtag_add_ir_scan_noverify(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
576 retval=interface_jtag_add_ir_scan(in_num_fields, in_fields, cmd_queue_end_state);
577 if (retval!=ERROR_OK)
584 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
586 * If the input field list contains an instruction value for a TAP then that is used
587 * otherwise the TAP is set to bypass.
589 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
592 void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
594 if (jtag_verify&&jtag_verify_capture_ir)
596 /* 8 x 32 bit id's is enough for all invoations */
598 for (int j = 0; j < in_num_fields; j++)
600 in_fields[j].check_value=NULL;
601 in_fields[j].check_mask=NULL;
602 /* if we are to run a verification of the ir scan, we need to get the input back.
603 * We may have to allocate space if the caller didn't ask for the input back.
605 in_fields[j].check_value=in_fields[j].tap->expected;
606 in_fields[j].check_mask=in_fields[j].tap->expected_mask;
608 jtag_add_scan_check(jtag_add_ir_scan_noverify, in_num_fields, in_fields, state);
611 jtag_add_ir_scan_noverify(in_num_fields, in_fields, state);
616 * see jtag_add_ir_scan()
619 int MINIDRIVER(interface_jtag_add_ir_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
621 size_t num_taps = jtag_NumEnabledTaps();
623 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
624 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
625 scan_field_t * out_fields = cmd_queue_alloc(num_taps * sizeof(scan_field_t));
627 jtag_queue_command(cmd);
629 cmd->type = JTAG_SCAN;
630 cmd->cmd.scan = scan;
632 scan->ir_scan = true;
633 scan->num_fields = num_taps; /* one field per device */
634 scan->fields = out_fields;
635 scan->end_state = state;
638 scan_field_t * field = out_fields; /* keep track where we insert data */
640 /* loop over all enabled TAPs */
642 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
644 /* search the input field list for fields for the current TAP */
648 for (int j = 0; j < in_num_fields; j++)
650 if (tap != in_fields[j].tap)
653 /* if TAP is listed in input fields, copy the value */
659 assert(in_fields[j].num_bits == tap->ir_length); /* input fields must have the same length as the TAP's IR */
661 cmd_queue_scan_field_clone(field, in_fields + j);
668 /* if a TAP isn't listed in input fields, set it to BYPASS */
673 field->num_bits = tap->ir_length;
674 field->out_value = buf_set_ones(cmd_queue_alloc(CEIL(tap->ir_length, 8)), tap->ir_length);
675 field->in_value = NULL; /* do not collect input for tap's in bypass */
678 /* update device information */
679 buf_cpy(field->out_value, tap->cur_instr, tap->ir_length);
684 assert(field == out_fields + num_taps); /* paranoia: jtag_NumEnabledTaps() and jtag_NextEnabledTap() not in sync */
690 * Duplicate the scan fields passed into the function into an IR SCAN command
692 * This function assumes that the caller handles extra fields for bypassed TAPs
695 void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
701 retval=interface_jtag_add_plain_ir_scan(in_num_fields, in_fields, cmd_queue_end_state);
702 if (retval!=ERROR_OK)
708 * see jtag_add_plain_ir_scan()
711 int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
714 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
715 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
716 scan_field_t * out_fields = cmd_queue_alloc(in_num_fields * sizeof(scan_field_t));
718 jtag_queue_command(cmd);
720 cmd->type = JTAG_SCAN;
721 cmd->cmd.scan = scan;
723 scan->ir_scan = true;
724 scan->num_fields = in_num_fields;
725 scan->fields = out_fields;
726 scan->end_state = state;
728 for (int i = 0; i < in_num_fields; i++)
729 cmd_queue_scan_field_clone(out_fields + i, in_fields + i);
736 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
738 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
740 return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
743 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
744 int in_num_fields, scan_field_t *in_fields, tap_state_t state)
746 for (int i = 0; i < in_num_fields; i++)
748 in_fields[i].allocated = 0;
749 in_fields[i].modified = 0;
750 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value == NULL))
752 in_fields[i].modified = 1;
753 /* we need storage space... */
754 #ifdef HAVE_JTAG_MINIDRIVER_H
755 if (in_fields[i].num_bits <= 32)
757 /* This is enough space and we're executing this synchronously */
758 in_fields[i].in_value = in_fields[i].intmp;
761 in_fields[i].in_value = (u8 *)malloc(CEIL(in_fields[i].num_bits, 8));
762 in_fields[i].allocated = 1;
765 in_fields[i].in_value = (u8 *)cmd_queue_alloc(CEIL(in_fields[i].num_bits, 8));
770 jtag_add_scan(in_num_fields, in_fields, state);
772 for (int i = 0; i < in_num_fields; i++)
774 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
776 /* this is synchronous for a minidriver */
777 jtag_add_callback4(jtag_check_value_mask_callback, in_fields[i].in_value,
778 (jtag_callback_data_t)in_fields[i].check_value,
779 (jtag_callback_data_t)in_fields[i].check_mask,
780 (jtag_callback_data_t)in_fields[i].num_bits);
782 if (in_fields[i].allocated)
784 free(in_fields[i].in_value);
786 if (in_fields[i].modified)
788 in_fields[i].in_value = NULL;
793 void jtag_add_dr_scan_check(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
797 jtag_add_scan_check(jtag_add_dr_scan, in_num_fields, in_fields, state);
800 jtag_add_dr_scan(in_num_fields, in_fields, state);
806 * Generate a DR SCAN using the fields passed to the function
808 * For not bypassed TAPs the function checks in_fields and uses fields specified there.
809 * For bypassed TAPs the function generates a dummy 1bit field.
811 * The bypass status of TAPs is set by jtag_add_ir_scan().
814 void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
820 retval=interface_jtag_add_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
821 if (retval!=ERROR_OK)
827 * see jtag_add_dr_scan()
830 int MINIDRIVER(interface_jtag_add_dr_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
832 /* count devices in bypass */
834 size_t bypass_devices = 0;
836 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
842 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
843 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
844 scan_field_t * out_fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(scan_field_t));
846 jtag_queue_command(cmd);
848 cmd->type = JTAG_SCAN;
849 cmd->cmd.scan = scan;
851 scan->ir_scan = false;
852 scan->num_fields = in_num_fields + bypass_devices;
853 scan->fields = out_fields;
854 scan->end_state = state;
857 scan_field_t * field = out_fields; /* keep track where we insert data */
859 /* loop over all enabled TAPs */
861 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
863 /* if TAP is not bypassed insert matching input fields */
867 scan_field_t * start_field = field; /* keep initial position for assert() */
869 for (int j = 0; j < in_num_fields; j++)
871 if (tap != in_fields[j].tap)
874 cmd_queue_scan_field_clone(field, in_fields + j);
879 assert(field > start_field); /* must have at least one input field per not bypassed TAP */
882 /* if a TAP is bypassed, generated a dummy bit*/
887 field->out_value = NULL;
888 field->in_value = NULL;
894 assert(field == out_fields + scan->num_fields); /* no superfluous input fields permitted */
902 * Generate a DR SCAN using the array of output values passed to the function
904 * This function assumes that the parameter target_tap specifies the one TAP
905 * that is not bypassed. All other TAPs must be bypassed and the function will
906 * generate a dummy 1bit field for them.
908 * For the target_tap a sequence of output-only fields will be generated where
909 * each field has the size num_bits and the field's values are taken from
912 * The bypass status of TAPs is set by jtag_add_ir_scan().
915 void MINIDRIVER(interface_jtag_add_dr_out)(jtag_tap_t *target_tap,
919 tap_state_t end_state)
921 /* count devices in bypass */
923 size_t bypass_devices = 0;
925 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
932 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
933 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
934 scan_field_t * out_fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(scan_field_t));
936 jtag_queue_command(cmd);
938 cmd->type = JTAG_SCAN;
939 cmd->cmd.scan = scan;
941 scan->ir_scan = false;
942 scan->num_fields = in_num_fields + bypass_devices;
943 scan->fields = out_fields;
944 scan->end_state = end_state;
947 bool target_tap_match = false;
949 scan_field_t * field = out_fields; /* keep track where we insert data */
951 /* loop over all enabled TAPs */
953 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
955 /* if TAP is not bypassed insert matching input fields */
959 assert(tap == target_tap); /* target_tap must match the one not bypassed TAP */
961 target_tap_match = true;
963 for (int j = 0; j < in_num_fields; j++)
966 size_t scan_size = num_bits[j];
967 buf_set_u32(out_value, 0, scan_size, value[j]);
970 field->num_bits = scan_size;
971 field->out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
972 field->in_value = NULL;
978 /* if a TAP is bypassed, generated a dummy bit*/
984 field->out_value = NULL;
985 field->in_value = NULL;
991 assert(target_tap_match); /* target_tap should be enabled and not bypassed */
996 * Duplicate the scan fields passed into the function into a DR SCAN command
998 * This function assumes that the caller handles extra fields for bypassed TAPs
1001 void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
1005 jtag_prelude(state);
1007 retval=interface_jtag_add_plain_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
1008 if (retval!=ERROR_OK)
1014 * see jtag_add_plain_dr_scan()
1017 int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
1019 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1020 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
1021 scan_field_t * out_fields = cmd_queue_alloc(in_num_fields * sizeof(scan_field_t));
1023 jtag_queue_command(cmd);
1025 cmd->type = JTAG_SCAN;
1026 cmd->cmd.scan = scan;
1028 scan->ir_scan = false;
1029 scan->num_fields = in_num_fields;
1030 scan->fields = out_fields;
1031 scan->end_state = state;
1033 for (int i = 0; i < in_num_fields; i++)
1034 cmd_queue_scan_field_clone(out_fields + i, in_fields + i);
1040 void jtag_add_tlr(void)
1042 jtag_prelude(TAP_RESET);
1045 retval=interface_jtag_add_tlr();
1046 if (retval!=ERROR_OK)
1050 int MINIDRIVER(interface_jtag_add_tlr)(void)
1052 tap_state_t state = TAP_RESET;
1054 /* allocate memory for a new list member */
1055 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1057 jtag_queue_command(cmd);
1059 cmd->type = JTAG_STATEMOVE;
1061 cmd->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1062 cmd->cmd.statemove->end_state = state;
1067 void jtag_add_pathmove(int num_states, const tap_state_t *path)
1069 tap_state_t cur_state = cmd_queue_cur_state;
1073 /* the last state has to be a stable state */
1074 if (!tap_is_state_stable(path[num_states - 1]))
1076 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
1080 for (i=0; i<num_states; i++)
1082 if (path[i] == TAP_RESET)
1084 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
1088 if ( tap_state_transition(cur_state, true) != path[i]
1089 && tap_state_transition(cur_state, false) != path[i])
1091 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
1094 cur_state = path[i];
1099 retval = interface_jtag_add_pathmove(num_states, path);
1100 cmd_queue_cur_state = path[num_states - 1];
1101 if (retval!=ERROR_OK)
1105 int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, const tap_state_t *path)
1107 /* allocate memory for a new list member */
1108 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1110 jtag_queue_command(cmd);
1112 cmd->type = JTAG_PATHMOVE;
1114 cmd->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
1115 cmd->cmd.pathmove->num_states = num_states;
1116 cmd->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);
1118 for (int i = 0; i < num_states; i++)
1119 cmd->cmd.pathmove->path[i] = path[i];
1124 int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, tap_state_t state)
1126 /* allocate memory for a new list member */
1127 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1129 jtag_queue_command(cmd);
1131 cmd->type = JTAG_RUNTEST;
1133 cmd->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
1134 cmd->cmd.runtest->num_cycles = num_cycles;
1135 cmd->cmd.runtest->end_state = state;
1140 void jtag_add_runtest(int num_cycles, tap_state_t state)
1144 jtag_prelude(state);
1146 /* executed by sw or hw fifo */
1147 retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
1148 if (retval!=ERROR_OK)
1153 int MINIDRIVER(interface_jtag_add_clocks)( int num_cycles )
1155 /* allocate memory for a new list member */
1156 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1158 jtag_queue_command(cmd);
1160 cmd->type = JTAG_STABLECLOCKS;
1162 cmd->cmd.stableclocks = cmd_queue_alloc(sizeof(stableclocks_command_t));
1163 cmd->cmd.stableclocks->num_cycles = num_cycles;
1168 void jtag_add_clocks( int num_cycles )
1172 if( !tap_is_state_stable(cmd_queue_cur_state) )
1174 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
1175 tap_state_name(cmd_queue_cur_state) );
1176 jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
1180 if( num_cycles > 0 )
1184 retval = interface_jtag_add_clocks(num_cycles);
1185 if (retval != ERROR_OK)
1190 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
1192 int trst_with_tlr = 0;
1195 /* FIX!!! there are *many* different cases here. A better
1196 * approach is needed for legal combinations of transitions...
1198 if ((jtag_reset_config & RESET_HAS_SRST)&&
1199 (jtag_reset_config & RESET_HAS_TRST)&&
1200 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
1202 if (((req_tlr_or_trst&&!jtag_trst)||
1203 (!req_tlr_or_trst&&jtag_trst))&&
1204 ((req_srst&&!jtag_srst)||
1205 (!req_srst&&jtag_srst)))
1207 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
1208 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
1212 /* Make sure that jtag_reset_config allows the requested reset */
1213 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
1214 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
1216 LOG_ERROR("BUG: requested reset would assert trst");
1217 jtag_error=ERROR_FAIL;
1221 /* if TRST pulls SRST, we reset with TAP T-L-R */
1222 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
1227 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
1229 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
1230 jtag_error=ERROR_FAIL;
1234 if (req_tlr_or_trst)
1236 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
1248 jtag_srst = req_srst;
1250 retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
1251 if (retval!=ERROR_OK)
1256 jtag_execute_queue();
1260 LOG_DEBUG("SRST line asserted");
1264 LOG_DEBUG("SRST line released");
1265 if (jtag_nsrst_delay)
1266 jtag_add_sleep(jtag_nsrst_delay * 1000);
1271 LOG_DEBUG("JTAG reset with RESET instead of TRST");
1272 jtag_add_end_state(TAP_RESET);
1274 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1280 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1281 * and inform possible listeners about this
1283 LOG_DEBUG("TRST line asserted");
1284 tap_set_state(TAP_RESET);
1285 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1289 if (jtag_ntrst_delay)
1290 jtag_add_sleep(jtag_ntrst_delay * 1000);
1294 int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
1296 /* allocate memory for a new list member */
1297 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1299 jtag_queue_command(cmd);
1301 cmd->type = JTAG_RESET;
1303 cmd->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
1304 cmd->cmd.reset->trst = req_trst;
1305 cmd->cmd.reset->srst = req_srst;
1310 void jtag_add_end_state(tap_state_t state)
1312 cmd_queue_end_state = state;
1313 if ((cmd_queue_end_state == TAP_DRSHIFT)||(cmd_queue_end_state == TAP_IRSHIFT))
1315 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
1319 int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
1321 /* allocate memory for a new list member */
1322 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1324 jtag_queue_command(cmd);
1326 cmd->type = JTAG_SLEEP;
1328 cmd->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
1329 cmd->cmd.sleep->us = us;
1334 void jtag_add_sleep(u32 us)
1336 keep_alive(); /* we might be running on a very slow JTAG clk */
1337 int retval=interface_jtag_add_sleep(us);
1338 if (retval!=ERROR_OK)
1343 int jtag_scan_size(const scan_command_t *cmd)
1348 /* count bits in scan command */
1349 for (i = 0; i < cmd->num_fields; i++)
1351 bit_count += cmd->fields[i].num_bits;
1357 int jtag_build_buffer(const scan_command_t *cmd, u8 **buffer)
1362 bit_count = jtag_scan_size(cmd);
1363 *buffer = calloc(1,CEIL(bit_count, 8));
1367 #ifdef _DEBUG_JTAG_IO_
1368 LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
1371 for (i = 0; i < cmd->num_fields; i++)
1373 if (cmd->fields[i].out_value)
1375 #ifdef _DEBUG_JTAG_IO_
1376 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);
1378 buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
1379 #ifdef _DEBUG_JTAG_IO_
1380 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
1386 #ifdef _DEBUG_JTAG_IO_
1387 LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
1391 bit_count += cmd->fields[i].num_bits;
1394 #ifdef _DEBUG_JTAG_IO_
1395 //LOG_DEBUG("bit_count totalling: %i", bit_count );
1401 int jtag_read_buffer(u8 *buffer, const scan_command_t *cmd)
1407 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1410 for (i = 0; i < cmd->num_fields; i++)
1412 /* if neither in_value nor in_handler
1413 * are specified we don't have to examine this field
1415 if (cmd->fields[i].in_value)
1417 int num_bits = cmd->fields[i].num_bits;
1418 u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
1420 #ifdef _DEBUG_JTAG_IO_
1421 char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1422 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
1426 if (cmd->fields[i].in_value)
1428 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
1433 bit_count += cmd->fields[i].num_bits;
1439 static const char *jtag_tap_name(const jtag_tap_t *tap)
1441 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
1444 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
1446 int retval = ERROR_OK;
1448 int compare_failed = 0;
1451 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
1453 compare_failed = buf_cmp(captured, in_check_value, num_bits);
1455 if (compare_failed){
1456 /* An error handler could have caught the failing check
1457 * only report a problem when there wasn't a handler, or if the handler
1458 * acknowledged the error
1461 LOG_WARNING("TAP %s:",
1462 jtag_tap_name(field->tap));
1466 char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1467 char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1471 char *in_check_mask_char;
1472 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1473 LOG_WARNING("value captured during scan didn't pass the requested check:");
1474 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1475 captured_char, in_check_value_char, in_check_mask_char);
1476 free(in_check_mask_char);
1480 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);
1483 free(captured_char);
1484 free(in_check_value_char);
1486 retval = ERROR_JTAG_QUEUE_FAILED;
1493 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
1495 assert(field->in_value != NULL);
1499 /* no checking to do */
1503 jtag_execute_queue_noclear();
1505 int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
1506 jtag_set_error(retval);
1511 enum scan_type jtag_scan_type(const scan_command_t *cmd)
1516 for (i = 0; i < cmd->num_fields; i++)
1518 if (cmd->fields[i].in_value)
1520 if (cmd->fields[i].out_value)
1528 #ifndef HAVE_JTAG_MINIDRIVER_H
1529 /* add callback to end of queue */
1530 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)
1532 struct jtag_callback_entry *entry=cmd_queue_alloc(sizeof(struct jtag_callback_entry));
1535 entry->callback=callback;
1541 if (jtag_callback_queue_head==NULL)
1543 jtag_callback_queue_head=entry;
1544 jtag_callback_queue_tail=entry;
1547 jtag_callback_queue_tail->next=entry;
1548 jtag_callback_queue_tail=entry;
1553 static int jtag_convert_to_callback4(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
1555 ((jtag_callback1_t)data1)(in);
1559 void jtag_add_callback(jtag_callback1_t callback, u8 *in)
1561 jtag_add_callback4(jtag_convert_to_callback4, in, (jtag_callback_data_t)callback, 0, 0);
1565 #ifndef HAVE_JTAG_MINIDRIVER_H
1567 int interface_jtag_execute_queue(void)
1573 LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
1577 retval = jtag->execute_queue();
1579 if (retval == ERROR_OK)
1581 struct jtag_callback_entry *entry;
1582 for (entry=jtag_callback_queue_head; entry!=NULL; entry=entry->next)
1584 retval=entry->callback(entry->in, entry->data1, entry->data2, entry->data3);
1585 if (retval!=ERROR_OK)
1592 jtag_callback_queue_head = NULL;
1593 jtag_callback_queue_tail = NULL;
1595 jtag_command_queue = NULL;
1596 last_command_pointer = &jtag_command_queue;
1602 void jtag_execute_queue_noclear(void)
1604 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
1605 * E.g. a JTAG over TCP/IP or USB....
1607 jtag_flush_queue_count++;
1609 int retval=interface_jtag_execute_queue();
1610 /* we keep the first error */
1611 if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
1617 int jtag_execute_queue(void)
1620 jtag_execute_queue_noclear();
1622 jtag_error=ERROR_OK;
1626 int jtag_reset_callback(enum jtag_event event, void *priv)
1628 jtag_tap_t *tap = priv;
1632 if (event == JTAG_TRST_ASSERTED)
1634 buf_set_ones(tap->cur_instr, tap->ir_length);
1641 void jtag_sleep(u32 us)
1643 alive_sleep(us/1000);
1646 /* Try to examine chain layout according to IEEE 1149.1 §12
1648 int jtag_examine_chain(void)
1652 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1655 int device_count = 0;
1656 u8 zero_check = 0x0;
1657 u8 one_check = 0xff;
1660 field.num_bits = sizeof(idcode_buffer) * 8;
1661 field.out_value = idcode_buffer;
1663 field.in_value = idcode_buffer;
1668 for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1670 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1673 jtag_add_plain_dr_scan(1, &field, TAP_RESET);
1674 jtag_execute_queue();
1676 for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1678 zero_check |= idcode_buffer[i];
1679 one_check &= idcode_buffer[i];
1682 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1683 if ((zero_check == 0x00) || (one_check == 0xff))
1685 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1686 return ERROR_JTAG_INIT_FAILED;
1689 /* point at the 1st tap */
1690 tap = jtag_NextEnabledTap(NULL);
1692 LOG_ERROR("JTAG: No taps enabled?");
1693 return ERROR_JTAG_INIT_FAILED;
1696 for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1698 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1699 if ((idcode & 1) == 0)
1701 /* LSB must not be 0, this indicates a device in bypass */
1702 LOG_WARNING("Tap/Device does not have IDCODE");
1713 /* some devices, such as AVR will output all 1's instead of TDI
1714 input value at end of chain. */
1715 if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1718 /* End of chain (invalid manufacturer ID)
1720 * The JTAG examine is the very first thing that happens
1722 * A single JTAG device requires only 64 bits to be read back correctly.
1724 * The code below adds a check that the rest of the data scanned (640 bits)
1725 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1727 * earlier and gives more helpful/explicit error messages.
1729 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1731 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1732 if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1734 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1742 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1743 manufacturer = EXTRACT_MFG(idcode);
1744 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1745 part = EXTRACT_PART(idcode);
1746 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1747 version = EXTRACT_VER(idcode);
1749 LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1750 ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1751 idcode, manufacturer, part, version);
1757 tap->idcode = idcode;
1759 if (tap->expected_ids_cnt > 0) {
1760 /* Loop over the expected identification codes and test for a match */
1762 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1763 if( tap->idcode == tap->expected_ids[ii] ){
1768 /* If none of the expected ids matched, log an error */
1769 if (ii == tap->expected_ids_cnt) {
1770 LOG_ERROR("JTAG tap: %s got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1773 EXTRACT_MFG( tap->idcode ),
1774 EXTRACT_PART( tap->idcode ),
1775 EXTRACT_VER( tap->idcode ) );
1776 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1777 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1780 tap->expected_ids_cnt,
1781 tap->expected_ids[ii],
1782 EXTRACT_MFG( tap->expected_ids[ii] ),
1783 EXTRACT_PART( tap->expected_ids[ii] ),
1784 EXTRACT_VER( tap->expected_ids[ii] ) );
1787 return ERROR_JTAG_INIT_FAILED;
1789 LOG_INFO("JTAG Tap/device matched");
1793 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1797 tap = jtag_NextEnabledTap(tap);
1802 /* see if number of discovered devices matches configuration */
1803 if (device_count != jtag_NumEnabledTaps())
1805 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1806 device_count, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1807 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1808 return ERROR_JTAG_INIT_FAILED;
1814 int jtag_validate_chain(void)
1817 int total_ir_length = 0;
1823 total_ir_length = 0;
1825 tap = jtag_NextEnabledTap(tap);
1829 total_ir_length += tap->ir_length;
1832 total_ir_length += 2;
1833 ir_test = malloc(CEIL(total_ir_length, 8));
1834 buf_set_ones(ir_test, total_ir_length);
1837 field.num_bits = total_ir_length;
1838 field.out_value = ir_test;
1839 field.in_value = ir_test;
1842 jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1843 jtag_execute_queue();
1849 tap = jtag_NextEnabledTap(tap);
1854 val = buf_get_u32(ir_test, chain_pos, 2);
1857 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1858 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);
1861 return ERROR_JTAG_INIT_FAILED;
1863 chain_pos += tap->ir_length;
1866 val = buf_get_u32(ir_test, chain_pos, 2);
1869 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1870 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);
1873 return ERROR_JTAG_INIT_FAILED;
1881 enum jtag_tap_cfg_param {
1885 static Jim_Nvp nvp_config_opts[] = {
1886 { .name = "-event", .value = JCFG_EVENT },
1888 { .name = NULL, .value = -1 }
1891 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1897 /* parse config or cget options */
1898 while (goi->argc > 0) {
1899 Jim_SetEmptyResult (goi->interp);
1901 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1903 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1909 if (goi->argc == 0) {
1910 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1914 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1916 Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1920 if (goi->isconfigure) {
1921 if (goi->argc != 1) {
1922 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1926 if (goi->argc != 0) {
1927 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1933 jtag_tap_event_action_t *jteap;
1935 jteap = tap->event_action;
1936 /* replace existing? */
1938 if (jteap->event == (enum jtag_tap_event)n->value) {
1941 jteap = jteap->next;
1944 if (goi->isconfigure) {
1945 if (jteap == NULL) {
1947 jteap = calloc(1, sizeof (*jteap));
1949 jteap->event = n->value;
1950 Jim_GetOpt_Obj( goi, &o);
1952 Jim_DecrRefCount(interp, jteap->body);
1954 jteap->body = Jim_DuplicateObj(goi->interp, o);
1955 Jim_IncrRefCount(jteap->body);
1957 /* add to head of event list */
1958 jteap->next = tap->event_action;
1959 tap->event_action = jteap;
1960 Jim_SetEmptyResult(goi->interp);
1963 if (jteap == NULL) {
1964 Jim_SetEmptyResult(goi->interp);
1966 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1973 } /* while (goi->argc) */
1978 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1988 const Jim_Nvp opts[] = {
1989 #define NTAP_OPT_IRLEN 0
1990 { .name = "-irlen" , .value = NTAP_OPT_IRLEN },
1991 #define NTAP_OPT_IRMASK 1
1992 { .name = "-irmask" , .value = NTAP_OPT_IRMASK },
1993 #define NTAP_OPT_IRCAPTURE 2
1994 { .name = "-ircapture" , .value = NTAP_OPT_IRCAPTURE },
1995 #define NTAP_OPT_ENABLED 3
1996 { .name = "-enable" , .value = NTAP_OPT_ENABLED },
1997 #define NTAP_OPT_DISABLED 4
1998 { .name = "-disable" , .value = NTAP_OPT_DISABLED },
1999 #define NTAP_OPT_EXPECTED_ID 5
2000 { .name = "-expected-id" , .value = NTAP_OPT_EXPECTED_ID },
2001 { .name = NULL , .value = -1 },
2004 pTap = malloc( sizeof(jtag_tap_t) );
2005 memset( pTap, 0, sizeof(*pTap) );
2007 Jim_SetResult_sprintf( goi->interp, "no memory");
2011 * we expect CHIP + TAP + OPTIONS
2013 if( goi->argc < 3 ){
2014 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
2017 Jim_GetOpt_String( goi, &cp, NULL );
2018 pTap->chip = strdup(cp);
2020 Jim_GetOpt_String( goi, &cp, NULL );
2021 pTap->tapname = strdup(cp);
2023 /* name + dot + name + null */
2024 x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
2026 sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
2027 pTap->dotted_name = cp;
2029 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
2030 pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
2032 /* default is enabled */
2035 /* deal with options */
2036 #define NTREQ_IRLEN 1
2037 #define NTREQ_IRCAPTURE 2
2038 #define NTREQ_IRMASK 4
2040 /* clear them as we find them */
2041 reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
2044 e = Jim_GetOpt_Nvp( goi, opts, &n );
2046 Jim_GetOpt_NvpUnknown( goi, opts, 0 );
2049 LOG_DEBUG("Processing option: %s", n->name );
2051 case NTAP_OPT_ENABLED:
2054 case NTAP_OPT_DISABLED:
2057 case NTAP_OPT_EXPECTED_ID:
2059 u32 *new_expected_ids;
2061 e = Jim_GetOpt_Wide( goi, &w );
2063 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
2067 new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
2068 if (new_expected_ids == NULL) {
2069 Jim_SetResult_sprintf( goi->interp, "no memory");
2073 memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
2075 new_expected_ids[pTap->expected_ids_cnt] = w;
2077 free(pTap->expected_ids);
2078 pTap->expected_ids = new_expected_ids;
2079 pTap->expected_ids_cnt++;
2082 case NTAP_OPT_IRLEN:
2083 case NTAP_OPT_IRMASK:
2084 case NTAP_OPT_IRCAPTURE:
2085 e = Jim_GetOpt_Wide( goi, &w );
2087 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
2090 if( (w < 0) || (w > 0xffff) ){
2092 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
2093 n->name, (int)(w), (int)(w));
2097 case NTAP_OPT_IRLEN:
2098 pTap->ir_length = w;
2099 reqbits &= (~(NTREQ_IRLEN));
2101 case NTAP_OPT_IRMASK:
2102 pTap->ir_capture_mask = w;
2103 reqbits &= (~(NTREQ_IRMASK));
2105 case NTAP_OPT_IRCAPTURE:
2106 pTap->ir_capture_value = w;
2107 reqbits &= (~(NTREQ_IRCAPTURE));
2110 } /* switch(n->value) */
2111 } /* while( goi->argc ) */
2113 /* Did we get all the options? */
2116 Jim_SetResult_sprintf( goi->interp,
2117 "newtap: %s missing required parameters",
2119 /* TODO: Tell user what is missing :-( */
2120 /* no memory leaks pelase */
2121 free(((void *)(pTap->expected_ids)));
2122 free(((void *)(pTap->chip)));
2123 free(((void *)(pTap->tapname)));
2124 free(((void *)(pTap->dotted_name)));
2125 free(((void *)(pTap)));
2129 pTap->expected = malloc( pTap->ir_length );
2130 pTap->expected_mask = malloc( pTap->ir_length );
2131 pTap->cur_instr = malloc( pTap->ir_length );
2133 buf_set_u32( pTap->expected,
2136 pTap->ir_capture_value );
2137 buf_set_u32( pTap->expected_mask,
2140 pTap->ir_capture_mask );
2141 buf_set_ones( pTap->cur_instr,
2146 jtag_register_event_callback(jtag_reset_callback, pTap );
2148 ppTap = &(jtag_all_taps);
2149 while( (*ppTap) != NULL ){
2150 ppTap = &((*ppTap)->next_tap);
2154 static int n_taps = 0;
2155 pTap->abs_chain_position = n_taps++;
2157 LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
2158 (*ppTap)->dotted_name,
2159 (*ppTap)->abs_chain_position,
2160 (*ppTap)->ir_length,
2161 (*ppTap)->ir_capture_value,
2162 (*ppTap)->ir_capture_mask );
2167 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
2173 struct command_context_s *context;
2177 JTAG_CMD_INIT_RESET,
2180 JTAG_CMD_TAPDISABLE,
2181 JTAG_CMD_TAPISENABLED,
2186 const Jim_Nvp jtag_cmds[] = {
2187 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
2188 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
2189 { .name = "newtap" , .value = JTAG_CMD_NEWTAP },
2190 { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED },
2191 { .name = "tapenable" , .value = JTAG_CMD_TAPENABLE },
2192 { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE },
2193 { .name = "configure" , .value = JTAG_CMD_CONFIGURE },
2194 { .name = "cget" , .value = JTAG_CMD_CGET },
2196 { .name = NULL, .value = -1 },
2199 context = Jim_GetAssocData(interp, "context");
2200 /* go past the command */
2201 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
2203 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
2205 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
2208 Jim_SetEmptyResult( goi.interp );
2210 case JTAG_CMD_INTERFACE:
2211 /* return the name of the interface */
2212 /* TCL code might need to know the exact type... */
2213 /* FUTURE: we allow this as a means to "set" the interface. */
2214 if( goi.argc != 0 ){
2215 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2218 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
2220 case JTAG_CMD_INIT_RESET:
2221 if( goi.argc != 0 ){
2222 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2225 e = jtag_init_reset(context);
2226 if( e != ERROR_OK ){
2227 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
2231 case JTAG_CMD_NEWTAP:
2232 return jim_newtap_cmd( &goi );
2234 case JTAG_CMD_TAPISENABLED:
2235 case JTAG_CMD_TAPENABLE:
2236 case JTAG_CMD_TAPDISABLE:
2237 if( goi.argc != 1 ){
2238 Jim_SetResultString( goi.interp, "Too many parameters",-1 );
2244 t = jtag_TapByJimObj( goi.interp, goi.argv[0] );
2249 case JTAG_CMD_TAPISENABLED:
2252 case JTAG_CMD_TAPENABLE:
2253 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
2257 case JTAG_CMD_TAPDISABLE:
2258 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
2263 Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
2270 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
2277 Jim_GetOpt_Obj(&goi, &o);
2278 t = jtag_TapByJimObj( goi.interp, o );
2283 goi.isconfigure = 0;
2284 return jtag_tap_configure_cmd( &goi, t);
2288 case JTAG_CMD_CONFIGURE:
2290 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
2297 Jim_GetOpt_Obj(&goi, &o);
2298 t = jtag_TapByJimObj( goi.interp, o );
2303 goi.isconfigure = 1;
2304 return jtag_tap_configure_cmd( &goi, t);
2311 int jtag_register_commands(struct command_context_s *cmd_ctx)
2313 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
2315 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
2316 COMMAND_CONFIG, "try to configure interface");
2317 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
2318 COMMAND_ANY, "set jtag speed (if supported)");
2319 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
2320 COMMAND_ANY, "same as jtag_speed, except it takes maximum khz as arguments. 0 KHz = RTCK.");
2321 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
2322 COMMAND_CONFIG, "jtag_device <ir_length> <ir_expected> <ir_mask>");
2323 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
2325 "[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]");
2326 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
2327 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
2328 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
2329 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
2331 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
2332 COMMAND_EXEC, "print current scan chain configuration");
2334 register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
2335 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
2336 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
2337 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
2338 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
2339 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
2340 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
2341 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
2342 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
2343 register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
2345 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
2346 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
2347 register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
2348 COMMAND_ANY, "verify value capture <enable|disable>");
2349 register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command,
2350 COMMAND_ANY, "choose short(default) or long tms_sequence <short|long>");
2354 int jtag_interface_init(struct command_context_s *cmd_ctx)
2359 if (!jtag_interface)
2361 /* nothing was previously specified by "interface" command */
2362 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
2363 return ERROR_JTAG_INVALID_INTERFACE;
2367 jtag_interface->khz(speed_khz, &jtag_speed);
2371 if (jtag_interface->init() != ERROR_OK)
2372 return ERROR_JTAG_INIT_FAILED;
2374 jtag = jtag_interface;
2378 static int jtag_init_inner(struct command_context_s *cmd_ctx)
2383 LOG_DEBUG("Init JTAG chain");
2385 tap = jtag_NextEnabledTap(NULL);
2387 LOG_ERROR("There are no enabled taps?");
2388 return ERROR_JTAG_INIT_FAILED;
2392 if ((retval=jtag_execute_queue())!=ERROR_OK)
2395 /* examine chain first, as this could discover the real chain layout */
2396 if (jtag_examine_chain() != ERROR_OK)
2398 LOG_ERROR("trying to validate configured JTAG chain anyway...");
2401 if (jtag_validate_chain() != ERROR_OK)
2403 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
2409 int jtag_init_reset(struct command_context_s *cmd_ctx)
2413 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2416 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
2418 /* Reset can happen after a power cycle.
2420 * Ideally we would only assert TRST or run RESET before the target reset.
2422 * However w/srst_pulls_trst, trst is asserted together with the target
2423 * reset whether we want it or not.
2425 * NB! Some targets have JTAG circuitry disabled until a
2426 * trst & srst has been asserted.
2428 * NB! here we assume nsrst/ntrst delay are sufficient!
2430 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
2433 jtag_add_reset(1, 0); /* RESET or TRST */
2434 if (jtag_reset_config & RESET_HAS_SRST)
2436 jtag_add_reset(1, 1);
2437 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
2438 jtag_add_reset(0, 1);
2440 jtag_add_reset(0, 0);
2441 if ((retval = jtag_execute_queue()) != ERROR_OK)
2444 /* Check that we can communication on the JTAG chain + eventually we want to
2445 * be able to perform enumeration only after OpenOCD has started
2446 * telnet and GDB server
2448 * That would allow users to more easily perform any magic they need to before
2451 return jtag_init_inner(cmd_ctx);
2454 int jtag_init(struct command_context_s *cmd_ctx)
2457 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2459 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
2463 return jtag_init_reset(cmd_ctx);
2466 static int default_khz(int khz, int *jtag_speed)
2468 LOG_ERROR("Translation from khz to jtag_speed not implemented");
2472 static int default_speed_div(int speed, int *khz)
2474 LOG_ERROR("Translation from jtag_speed to khz not implemented");
2478 static int default_power_dropout(int *dropout)
2480 *dropout=0; /* by default we can't detect power dropout */
2484 static int default_srst_asserted(int *srst_asserted)
2486 *srst_asserted=0; /* by default we can't detect srst asserted */
2490 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2495 /* check whether the interface is already configured */
2498 LOG_WARNING("Interface already configured, ignoring");
2502 /* interface name is a mandatory argument */
2503 if (argc < 1 || args[0][0] == '\0')
2505 return ERROR_COMMAND_SYNTAX_ERROR;
2508 for (i=0; jtag_interfaces[i]; i++)
2510 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
2512 if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
2517 jtag_interface = jtag_interfaces[i];
2519 if (jtag_interface->khz == NULL)
2521 jtag_interface->khz = default_khz;
2523 if (jtag_interface->speed_div == NULL)
2525 jtag_interface->speed_div = default_speed_div;
2527 if (jtag_interface->power_dropout == NULL)
2529 jtag_interface->power_dropout = default_power_dropout;
2531 if (jtag_interface->srst_asserted == NULL)
2533 jtag_interface->srst_asserted = default_srst_asserted;
2540 /* no valid interface was found (i.e. the configuration option,
2541 * didn't match one of the compiled-in interfaces
2543 LOG_ERROR("No valid jtag interface found (%s)", args[0]);
2544 LOG_ERROR("compiled-in jtag interfaces:");
2545 for (i = 0; jtag_interfaces[i]; i++)
2547 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
2550 return ERROR_JTAG_INVALID_INTERFACE;
2553 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2557 Jim_Obj *newargs[ 10 ];
2560 * argv[-1] = command
2561 * argv[ 0] = ir length
2562 * argv[ 1] = ir capture
2563 * argv[ 2] = ir mask
2564 * argv[ 3] = not actually used by anything but in the docs
2568 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2571 command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2572 command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2576 command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2577 command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2578 command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2579 command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
2581 newargs[0] = Jim_NewStringObj( interp, "jtag", -1 );
2582 newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
2583 sprintf( buf, "chip%d", jtag_NumTotalTaps() );
2584 newargs[2] = Jim_NewStringObj( interp, buf, -1 );
2585 sprintf( buf, "tap%d", jtag_NumTotalTaps() );
2586 newargs[3] = Jim_NewStringObj( interp, buf, -1 );
2587 newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 );
2588 newargs[5] = Jim_NewStringObj( interp, args[0], -1 );
2589 newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 );
2590 newargs[7] = Jim_NewStringObj( interp, args[1], -1 );
2591 newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 );
2592 newargs[9] = Jim_NewStringObj( interp, args[2], -1 );
2594 command_print( cmd_ctx, "NEW COMMAND:");
2595 sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
2596 Jim_GetString( newargs[0], NULL ),
2597 Jim_GetString( newargs[1], NULL ),
2598 Jim_GetString( newargs[2], NULL ),
2599 Jim_GetString( newargs[3], NULL ),
2600 Jim_GetString( newargs[4], NULL ),
2601 Jim_GetString( newargs[5], NULL ),
2602 Jim_GetString( newargs[6], NULL ),
2603 Jim_GetString( newargs[7], NULL ),
2604 Jim_GetString( newargs[8], NULL ),
2605 Jim_GetString( newargs[9], NULL ) );
2607 e = jim_jtag_command( interp, 10, newargs );
2609 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
2614 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2618 tap = jtag_all_taps;
2619 command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
2620 command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
2623 u32 expected, expected_mask, cur_instr, ii;
2624 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
2625 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
2626 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
2628 command_print(cmd_ctx,
2629 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2630 tap->abs_chain_position,
2632 tap->enabled ? 'Y' : 'n',
2634 (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
2640 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
2641 command_print(cmd_ctx, " | | | | 0x%08x | | | | ",
2642 tap->expected_ids[ii]);
2645 tap = tap->next_tap;
2651 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2654 return ERROR_COMMAND_SYNTAX_ERROR;
2658 if (strcmp(args[0], "none") == 0)
2659 jtag_reset_config = RESET_NONE;
2660 else if (strcmp(args[0], "trst_only") == 0)
2661 jtag_reset_config = RESET_HAS_TRST;
2662 else if (strcmp(args[0], "srst_only") == 0)
2663 jtag_reset_config = RESET_HAS_SRST;
2664 else if (strcmp(args[0], "trst_and_srst") == 0)
2665 jtag_reset_config = RESET_TRST_AND_SRST;
2668 LOG_ERROR("(1) invalid reset_config argument (%s), defaulting to none", args[0]);
2669 jtag_reset_config = RESET_NONE;
2670 return ERROR_INVALID_ARGUMENTS;
2676 if (strcmp(args[1], "separate") == 0)
2678 /* seperate reset lines - default */
2681 if (strcmp(args[1], "srst_pulls_trst") == 0)
2682 jtag_reset_config |= RESET_SRST_PULLS_TRST;
2683 else if (strcmp(args[1], "trst_pulls_srst") == 0)
2684 jtag_reset_config |= RESET_TRST_PULLS_SRST;
2685 else if (strcmp(args[1], "combined") == 0)
2686 jtag_reset_config |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2689 LOG_ERROR("(2) invalid reset_config argument (%s), defaulting to none", args[1]);
2690 jtag_reset_config = RESET_NONE;
2691 return ERROR_INVALID_ARGUMENTS;
2698 if (strcmp(args[2], "trst_open_drain") == 0)
2699 jtag_reset_config |= RESET_TRST_OPEN_DRAIN;
2700 else if (strcmp(args[2], "trst_push_pull") == 0)
2701 jtag_reset_config &= ~RESET_TRST_OPEN_DRAIN;
2704 LOG_ERROR("(3) invalid reset_config argument (%s) defaulting to none", args[2] );
2705 jtag_reset_config = RESET_NONE;
2706 return ERROR_INVALID_ARGUMENTS;
2712 if (strcmp(args[3], "srst_push_pull") == 0)
2713 jtag_reset_config |= RESET_SRST_PUSH_PULL;
2714 else if (strcmp(args[3], "srst_open_drain") == 0)
2715 jtag_reset_config &= ~RESET_SRST_PUSH_PULL;
2718 LOG_ERROR("(4) invalid reset_config argument (%s), defaulting to none", args[3]);
2719 jtag_reset_config = RESET_NONE;
2720 return ERROR_INVALID_ARGUMENTS;
2727 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2731 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2736 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
2742 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2746 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2751 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
2757 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2759 int retval=ERROR_OK;
2763 LOG_DEBUG("handle jtag speed");
2766 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2768 /* this command can be called during CONFIG,
2769 * in which case jtag isn't initialized */
2772 retval=jtag->speed(cur_speed);
2774 } else if (argc == 0)
2778 return ERROR_COMMAND_SYNTAX_ERROR;
2780 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2785 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2787 int retval=ERROR_OK;
2788 LOG_DEBUG("handle jtag khz");
2792 speed_khz = strtoul(args[0], NULL, 0);
2796 LOG_DEBUG("have interface set up");
2798 if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
2804 cur_speed = jtag_speed = speed_div1;
2806 retval=jtag->speed(cur_speed);
2815 return ERROR_COMMAND_SYNTAX_ERROR;
2820 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
2826 command_print(cmd_ctx, "RCLK - adaptive");
2829 command_print(cmd_ctx, "%d kHz", speed_khz);
2835 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2841 return ERROR_COMMAND_SYNTAX_ERROR;
2845 state = tap_state_by_name( args[0] );
2847 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2848 return ERROR_COMMAND_SYNTAX_ERROR;
2850 jtag_add_end_state(state);
2851 jtag_execute_queue();
2853 command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
2858 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2865 return ERROR_COMMAND_SYNTAX_ERROR;
2868 if (args[0][0] == '1')
2870 else if (args[0][0] == '0')
2874 return ERROR_COMMAND_SYNTAX_ERROR;
2877 if (args[1][0] == '1')
2879 else if (args[1][0] == '0')
2883 return ERROR_COMMAND_SYNTAX_ERROR;
2886 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2887 return ERROR_JTAG_INIT_FAILED;
2889 jtag_add_reset(trst, srst);
2890 jtag_execute_queue();
2895 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2899 return ERROR_COMMAND_SYNTAX_ERROR;
2902 jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
2903 jtag_execute_queue();
2909 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2912 scan_field_t *fields;
2914 tap_state_t endstate;
2916 if ((argc < 2) || (argc % 2))
2918 return ERROR_COMMAND_SYNTAX_ERROR;
2921 /* optional "-endstate" */
2923 /* at the end of the arguments. */
2925 endstate = cmd_queue_end_state;
2927 /* have at least one pair of numbers. */
2928 /* is last pair the magic text? */
2929 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2932 cpA = args[ argc-1 ];
2933 for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2934 cpS = tap_state_name( endstate );
2935 if( 0 == strcmp( cpA, cpS ) ){
2939 if( endstate >= TAP_NUM_STATES ){
2940 return ERROR_COMMAND_SYNTAX_ERROR;
2942 /* found - remove the last 2 args */
2948 int num_fields = argc / 2;
2950 fields = malloc(sizeof(scan_field_t) * num_fields);
2952 for (i = 0; i < num_fields; i++)
2954 tap = jtag_TapByString( args[i*2] );
2957 command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2960 int field_size = tap->ir_length;
2961 fields[i].tap = tap;
2962 fields[i].num_bits = field_size;
2963 fields[i].out_value = malloc(CEIL(field_size, 8));
2964 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2965 fields[i].in_value = NULL;
2968 /* did we have an endstate? */
2969 jtag_add_ir_scan(num_fields, fields, endstate);
2971 int retval=jtag_execute_queue();
2973 for (i = 0; i < num_fields; i++)
2974 free(fields[i].out_value);
2981 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2984 scan_field_t *fields;
2986 int field_count = 0;
2989 tap_state_t endstate;
2992 * args[2] = num_bits
2993 * args[3] = hex string
2994 * ... repeat num bits and hex string ...
2997 * args[N-2] = "-endstate"
2998 * args[N-1] = statename
3000 if ((argc < 4) || ((argc % 2)!=0))
3002 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
3006 /* assume no endstate */
3007 endstate = cmd_queue_end_state;
3008 /* validate arguments as numbers */
3010 for (i = 2; i < argc; i+=2)
3015 e = Jim_GetLong(interp, args[i], &bits);
3016 /* If valid - try next arg */
3021 /* Not valid.. are we at the end? */
3022 if ( ((i+2) != argc) ){
3023 /* nope, then error */
3027 /* it could be: "-endstate FOO" */
3029 /* get arg as a string. */
3030 cp = Jim_GetString( args[i], NULL );
3031 /* is it the magic? */
3032 if( 0 == strcmp( "-endstate", cp ) ){
3033 /* is the statename valid? */
3034 cp = Jim_GetString( args[i+1], NULL );
3036 /* see if it is a valid state name */
3037 endstate = tap_state_by_name(cp);
3039 /* update the error message */
3040 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
3042 /* valid - so clear the error */
3044 /* and remove the last 2 args */
3049 /* Still an error? */
3051 return e; /* too bad */
3053 } /* validate args */
3055 tap = jtag_TapByJimObj( interp, args[1] );
3060 num_fields=(argc-2)/2;
3061 fields = malloc(sizeof(scan_field_t) * num_fields);
3062 for (i = 2; i < argc; i+=2)
3068 Jim_GetLong(interp, args[i], &bits);
3069 str = Jim_GetString(args[i+1], &len);
3071 fields[field_count].tap = tap;
3072 fields[field_count].num_bits = bits;
3073 fields[field_count].out_value = malloc(CEIL(bits, 8));
3074 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
3075 fields[field_count].in_value = fields[field_count].out_value;
3079 jtag_add_dr_scan(num_fields, fields, endstate);
3081 retval = jtag_execute_queue();
3082 if (retval != ERROR_OK)
3084 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
3089 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
3090 for (i = 2; i < argc; i+=2)
3095 Jim_GetLong(interp, args[i], &bits);
3096 str = buf_to_str(fields[field_count].in_value, bits, 16);
3097 free(fields[field_count].out_value);
3099 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
3104 Jim_SetResult(interp, list);
3112 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
3114 Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_flush_queue_count));
3120 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3124 if (strcmp(args[0], "enable") == 0)
3126 jtag_verify_capture_ir = 1;
3128 else if (strcmp(args[0], "disable") == 0)
3130 jtag_verify_capture_ir = 0;
3133 return ERROR_COMMAND_SYNTAX_ERROR;
3135 } else if (argc != 0)
3137 return ERROR_COMMAND_SYNTAX_ERROR;
3140 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
3145 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3149 if (strcmp(args[0], "enable") == 0)
3153 else if (strcmp(args[0], "disable") == 0)
3158 return ERROR_COMMAND_SYNTAX_ERROR;
3160 } else if (argc != 0)
3162 return ERROR_COMMAND_SYNTAX_ERROR;
3165 command_print(cmd_ctx, "verify jtag capture is %s", (jtag_verify) ? "enabled": "disabled");
3171 int jtag_power_dropout(int *dropout)
3173 return jtag->power_dropout(dropout);
3176 int jtag_srst_asserted(int *srst_asserted)
3178 return jtag->srst_asserted(srst_asserted);
3181 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
3183 jtag_tap_event_action_t * jteap;
3186 jteap = tap->event_action;
3190 if (jteap->event == e) {
3192 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
3195 Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
3196 Jim_GetString(jteap->body, NULL) );
3197 if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
3198 Jim_PrintErrorMessage(interp);
3202 jteap = jteap->next;
3206 LOG_DEBUG( "event %d %s - no action",
3208 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
3212 /*-----<Cable Helper API>---------------------------------------*/
3214 /* these Cable Helper API functions are all documented in the jtag.h header file,
3215 using a Doxygen format. And since Doxygen's configuration file "Doxyfile",
3216 is setup to prefer its docs in the header file, no documentation is here, for
3217 if it were, it would have to be doubly maintained.
3221 * @see tap_set_state() and tap_get_state() accessors.
3222 * Actual name is not important since accessors hide it.
3224 static tap_state_t state_follower = TAP_RESET;
3226 void tap_set_state_impl( tap_state_t new_state )
3228 /* this is the state we think the TAPs are in now, was cur_state */
3229 state_follower = new_state;
3232 tap_state_t tap_get_state()
3234 return state_follower;
3238 * @see tap_set_end_state() and tap_get_end_state() accessors.
3239 * Actual name is not important because accessors hide it.
3241 static tap_state_t end_state_follower = TAP_RESET;
3243 void tap_set_end_state( tap_state_t new_end_state )
3245 /* this is the state we think the TAPs will be in at completion of the
3246 current TAP operation, was end_state
3248 end_state_follower = new_end_state;
3251 tap_state_t tap_get_end_state()
3253 return end_state_follower;
3257 int tap_move_ndx( tap_state_t astate )
3259 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
3265 case TAP_RESET: ndx = 0; break;
3266 case TAP_DRSHIFT: ndx = 2; break;
3267 case TAP_DRPAUSE: ndx = 3; break;
3268 case TAP_IDLE: ndx = 1; break;
3269 case TAP_IRSHIFT: ndx = 4; break;
3270 case TAP_IRPAUSE: ndx = 5; break;
3272 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate) );
3280 /* tap_move[i][j]: tap movement command to go from state i to state j
3281 * 0: Test-Logic-Reset
3288 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
3290 struct tms_sequences
3298 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
3299 * Read the bits from LSBit first to MSBit last (right-to-left).
3301 #define HEX__(n) 0x##n##LU
3304 (((x) & 0x0000000FLU)?(1<<0):0) \
3305 +(((x) & 0x000000F0LU)?(1<<1):0) \
3306 +(((x) & 0x00000F00LU)?(1<<2):0) \
3307 +(((x) & 0x0000F000LU)?(1<<3):0) \
3308 +(((x) & 0x000F0000LU)?(1<<4):0) \
3309 +(((x) & 0x00F00000LU)?(1<<5):0) \
3310 +(((x) & 0x0F000000LU)?(1<<6):0) \
3311 +(((x) & 0xF0000000LU)?(1<<7):0)
3313 #define B8(bits,count) { ((u8)B8__(HEX__(bits))), (count) }
3315 static const struct tms_sequences old_tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3317 /* value clocked to TMS to move from one of six stable states to another.
3318 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
3319 * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
3320 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
3321 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
3327 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3328 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3329 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
3330 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
3331 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
3332 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
3333 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* IRPAUSE */
3338 static const struct tms_sequences short_tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3340 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
3342 OK, I added Peter's version of the state table, and it works OK for
3343 me on MC1322x. I've recreated the jlink portion of patch with this
3344 new state table. His changes to my state table are pretty minor in
3345 terms of total transitions, but Peter feels that his version fixes
3346 some long-standing problems.
3349 I added the bit count into the table, reduced RESET column to 7 bits from 8.
3352 state specific comments:
3353 ------------------------
3354 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
3355 work better on ARM9 with ft2232 driver. (Dick)
3357 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3358 needed on ARM9 with ft2232 driver. (Dick)
3360 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3361 needed on ARM9 with ft2232 driver. (Dick)
3365 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3366 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3367 { B8(1111111,7), B8(0000000,7), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
3368 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
3369 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
3370 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
3371 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
3375 typedef const struct tms_sequences tms_table[6][6];
3377 static tms_table *tms_seqs=&short_tms_seqs;
3379 int tap_get_tms_path( tap_state_t from, tap_state_t to )
3381 return (*tms_seqs)[tap_move_ndx(from)][tap_move_ndx(to)].bits;
3385 int tap_get_tms_path_len( tap_state_t from, tap_state_t to )
3387 return (*tms_seqs)[tap_move_ndx(from)][tap_move_ndx(to)].bit_count;
3391 bool tap_is_state_stable(tap_state_t astate)
3395 /* A switch() is used because it is symbol dependent
3396 (not value dependent like an array), and can also check bounds.
3415 tap_state_t tap_state_transition(tap_state_t cur_state, bool tms)
3417 tap_state_t new_state;
3419 /* A switch is used because it is symbol dependent and not value dependent
3420 like an array. Also it can check for out of range conditions.
3428 new_state = cur_state;
3433 new_state = TAP_DRSELECT;
3436 new_state = TAP_IRSELECT;
3440 new_state = TAP_DREXIT1;
3444 new_state = TAP_DRUPDATE;
3447 new_state = TAP_DREXIT2;
3450 new_state = TAP_RESET;
3454 new_state = TAP_IREXIT1;
3458 new_state = TAP_IRUPDATE;
3461 new_state = TAP_IREXIT2;
3464 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3477 new_state = TAP_IDLE;
3480 new_state = TAP_DRCAPTURE;
3485 new_state = TAP_DRSHIFT;
3489 new_state = TAP_DRPAUSE;
3492 new_state = TAP_IRCAPTURE;
3497 new_state = TAP_IRSHIFT;
3501 new_state = TAP_IRPAUSE;
3504 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3513 const char* tap_state_name(tap_state_t state)
3519 case TAP_RESET: ret = "RESET"; break;
3520 case TAP_IDLE: ret = "RUN/IDLE"; break;
3521 case TAP_DRSELECT: ret = "DRSELECT"; break;
3522 case TAP_DRCAPTURE: ret = "DRCAPTURE"; break;
3523 case TAP_DRSHIFT: ret = "DRSHIFT"; break;
3524 case TAP_DREXIT1: ret = "DREXIT1"; break;
3525 case TAP_DRPAUSE: ret = "DRPAUSE"; break;
3526 case TAP_DREXIT2: ret = "DREXIT2"; break;
3527 case TAP_DRUPDATE: ret = "DRUPDATE"; break;
3528 case TAP_IRSELECT: ret = "IRSELECT"; break;
3529 case TAP_IRCAPTURE: ret = "IRCAPTURE"; break;
3530 case TAP_IRSHIFT: ret = "IRSHIFT"; break;
3531 case TAP_IREXIT1: ret = "IREXIT1"; break;
3532 case TAP_IRPAUSE: ret = "IRPAUSE"; break;
3533 case TAP_IREXIT2: ret = "IREXIT2"; break;
3534 case TAP_IRUPDATE: ret = "IRUPDATE"; break;
3535 default: ret = "???";
3541 static tap_state_t tap_state_by_name( const char *name )
3545 for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
3546 /* be nice to the human */
3547 if( 0 == strcasecmp( name, tap_state_name(x) ) ){
3555 #ifdef _DEBUG_JTAG_IO_
3557 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3558 do { buf[len] = bit ? '1' : '0'; } while(0)
3559 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3560 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3561 tap_state_name(a), tap_state_name(b), astr, bstr)
3563 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
3564 unsigned tap_bits, tap_state_t next_state)
3566 const u8 *tms_buffer;
3567 const u8 *tdi_buffer;
3572 unsigned tap_out_bits;
3576 tap_state_t last_state;
3578 // set startstate (and possibly last, if tap_bits == 0)
3579 last_state = next_state;
3580 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
3582 tms_buffer = (const u8 *)tms_buf;
3583 tdi_buffer = (const u8 *)tdi_buf;
3585 tap_bytes = TAP_SCAN_BYTES(tap_bits);
3586 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
3589 for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
3591 for(cur_bit = 0; cur_bit < 8; cur_bit++)
3593 // make sure we do not run off the end of the buffers
3594 unsigned tap_bit = cur_byte * 8 + cur_bit;
3595 if (tap_bit == tap_bits)
3598 // check and save TMS bit
3599 tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
3600 JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
3602 // use TMS bit to find the next TAP state
3603 next_state = tap_state_transition(last_state, tap_bit);
3605 // check and store TDI bit
3606 tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
3607 JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
3609 // increment TAP bits
3612 // Only show TDO bits on state transitions, or
3613 // after some number of bits in the same state.
3614 if ((next_state == last_state) && (tap_out_bits < 32))
3617 // terminate strings and display state transition
3618 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3619 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3622 last_state = next_state;
3629 // terminate strings and display state transition
3630 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3631 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3634 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
3638 #endif // _DEBUG_JTAG_IO_
3640 #ifndef HAVE_JTAG_MINIDRIVER_H
3641 void jtag_alloc_in_value32(scan_field_t *field)
3643 field->in_value=(u8 *)cmd_queue_alloc(4);
3647 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3651 if (strcmp(args[0], "short") == 0)
3653 tms_seqs=&short_tms_seqs;
3655 else if (strcmp(args[0], "long") == 0)
3657 tms_seqs=&old_tms_seqs;
3660 return ERROR_COMMAND_SYNTAX_ERROR;
3662 } else if (argc != 0)
3664 return ERROR_COMMAND_SYNTAX_ERROR;
3667 command_print(cmd_ctx, "tms sequence is %s", (tms_seqs==&short_tms_seqs) ? "short": "long");
3672 /*-----</Cable Helper API>--------------------------------------*/