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 #define INCLUDE_JTAG_MINIDRIVER_H
39 int jtag_flush_queue_count; /* count # of flushes for profiling / debugging purposes */
41 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
42 int in_num_fields, scan_field_t *in_fields, tap_state_t state);
44 /* note that this is not marked as static as it must be available from outside jtag.c for those
45 that implement the jtag_xxx() minidriver layer
47 int jtag_error=ERROR_OK;
49 typedef struct cmd_queue_page_s
53 struct cmd_queue_page_s *next;
56 #define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
57 static cmd_queue_page_t *cmd_queue_pages = NULL;
59 char* jtag_event_strings[] =
61 "JTAG controller reset (RESET or TRST)"
64 const Jim_Nvp nvp_jtag_tap_event[] = {
65 { .value = JTAG_TAP_EVENT_ENABLE, .name = "tap-enable" },
66 { .value = JTAG_TAP_EVENT_DISABLE, .name = "tap-disable" },
68 { .name = NULL, .value = -1 }
74 #ifndef HAVE_JTAG_MINIDRIVER_H
75 struct jtag_callback_entry
77 struct jtag_callback_entry *next;
79 jtag_callback_t callback;
81 jtag_callback_data_t data1;
82 jtag_callback_data_t data2;
83 jtag_callback_data_t data3;
87 static struct jtag_callback_entry *jtag_callback_queue_head = NULL;
88 static struct jtag_callback_entry *jtag_callback_queue_tail = NULL;
92 jtag_command_t *jtag_command_queue = NULL;
93 jtag_command_t **last_command_pointer = &jtag_command_queue;
94 static jtag_tap_t *jtag_all_taps = NULL;
96 enum reset_types jtag_reset_config = RESET_NONE;
97 tap_state_t cmd_queue_end_state = TAP_RESET;
98 tap_state_t cmd_queue_cur_state = TAP_RESET;
100 int jtag_verify_capture_ir = 1;
103 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
104 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
105 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
107 /* maximum number of JTAG devices expected in the chain
109 #define JTAG_MAX_CHAIN_SIZE 20
111 /* callbacks to inform high-level handlers about JTAG state changes */
112 jtag_event_callback_t *jtag_event_callbacks;
115 static int speed_khz = 0;
116 /* flag if the kHz speed was defined */
117 static int hasKHz = 0;
119 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
122 #if BUILD_ECOSBOARD == 1
123 extern jtag_interface_t zy1000_interface;
126 #if BUILD_PARPORT == 1
127 extern jtag_interface_t parport_interface;
131 extern jtag_interface_t dummy_interface;
134 #if BUILD_FT2232_FTD2XX == 1
135 extern jtag_interface_t ft2232_interface;
138 #if BUILD_FT2232_LIBFTDI == 1
139 extern jtag_interface_t ft2232_interface;
142 #if BUILD_AMTJTAGACCEL == 1
143 extern jtag_interface_t amt_jtagaccel_interface;
146 #if BUILD_EP93XX == 1
147 extern jtag_interface_t ep93xx_interface;
150 #if BUILD_AT91RM9200 == 1
151 extern jtag_interface_t at91rm9200_interface;
154 #if BUILD_GW16012 == 1
155 extern jtag_interface_t gw16012_interface;
158 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
159 extern jtag_interface_t presto_interface;
162 #if BUILD_USBPROG == 1
163 extern jtag_interface_t usbprog_interface;
167 extern jtag_interface_t jlink_interface;
170 #if BUILD_VSLLINK == 1
171 extern jtag_interface_t vsllink_interface;
175 extern jtag_interface_t rlink_interface;
178 #if BUILD_ARMJTAGEW == 1
179 extern jtag_interface_t armjtagew_interface;
182 jtag_interface_t *jtag_interfaces[] = {
183 #if BUILD_ECOSBOARD == 1
186 #if BUILD_PARPORT == 1
192 #if BUILD_FT2232_FTD2XX == 1
195 #if BUILD_FT2232_LIBFTDI == 1
198 #if BUILD_AMTJTAGACCEL == 1
199 &amt_jtagaccel_interface,
201 #if BUILD_EP93XX == 1
204 #if BUILD_AT91RM9200 == 1
205 &at91rm9200_interface,
207 #if BUILD_GW16012 == 1
210 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
213 #if BUILD_USBPROG == 1
219 #if BUILD_VSLLINK == 1
225 #if BUILD_ARMJTAGEW == 1
226 &armjtagew_interface,
231 static jtag_interface_t *jtag = NULL;
234 static jtag_interface_t *jtag_interface = NULL;
237 /* forward declarations */
238 //void jtag_add_pathmove(int num_states, tap_state_t *path);
239 //void jtag_add_runtest(int num_cycles, tap_state_t endstate);
240 //void jtag_add_end_state(tap_state_t endstate);
241 //void jtag_add_sleep(u32 us);
242 //int jtag_execute_queue(void);
243 static tap_state_t tap_state_by_name(const char *name);
246 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
247 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
248 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
249 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
250 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
251 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
252 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
254 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
256 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
257 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
258 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
259 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
260 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
261 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args);
263 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
264 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
265 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
267 jtag_tap_t *jtag_AllTaps(void)
269 return jtag_all_taps;
272 int jtag_NumTotalTaps(void)
286 int jtag_NumEnabledTaps(void)
302 jtag_tap_t *jtag_TapByString( const char *s )
310 if( 0 == strcmp( t->dotted_name, s ) ){
316 /* backup plan is by number */
318 /* ok - is "s" a number? */
320 n = strtol( s, &cp, 0 );
321 if( (s != cp) && (*cp == 0) ){
323 t = jtag_TapByAbsPosition(n);
329 jtag_tap_t * jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *o )
334 cp = Jim_GetString( o, NULL );
339 t = jtag_TapByString( cp );
342 Jim_SetResult_sprintf(interp,"Tap: %s is unknown", cp );
347 /* returns a pointer to the n-th device in the scan chain */
348 jtag_tap_t * jtag_TapByAbsPosition( int n )
356 while( t && (n > 0)) {
363 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
365 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
367 if (callback == NULL)
369 return ERROR_INVALID_ARGUMENTS;
374 while ((*callbacks_p)->next)
375 callbacks_p = &((*callbacks_p)->next);
376 callbacks_p = &((*callbacks_p)->next);
379 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
380 (*callbacks_p)->callback = callback;
381 (*callbacks_p)->priv = priv;
382 (*callbacks_p)->next = NULL;
387 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
389 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
391 if (callback == NULL)
393 return ERROR_INVALID_ARGUMENTS;
398 jtag_event_callback_t **next = &((*callbacks_p)->next);
399 if ((*callbacks_p)->callback == callback)
402 *callbacks_p = *next;
410 int jtag_call_event_callbacks(enum jtag_event event)
412 jtag_event_callback_t *callback = jtag_event_callbacks;
414 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
418 callback->callback(event, callback->priv);
419 callback = callback->next;
425 /* returns a pointer to the pointer of the last command in queue
426 * this may be a pointer to the root pointer (jtag_command_queue)
427 * or to the next member of the last but one command
429 jtag_command_t** jtag_get_last_command_p(void)
431 /* jtag_command_t *cmd = jtag_command_queue;
437 return &jtag_command_queue;
441 return last_command_pointer;
445 void jtag_queue_command(jtag_command_t * cmd)
447 jtag_command_t **last_cmd;
449 last_cmd = jtag_get_last_command_p();
453 (*last_cmd)->next = NULL;
455 last_command_pointer = &((*last_cmd)->next);
459 void* cmd_queue_alloc(size_t size)
461 cmd_queue_page_t **p_page = &cmd_queue_pages;
467 * We align/round the *SIZE* per below
468 * so that all pointers returned by
469 * this function are reasonably well
472 * If we did not, then an "odd-length" request would cause the
473 * *next* allocation to be at an *odd* address, and because
474 * this function has the same type of api as malloc() - we
475 * must also return pointers that have the same type of
478 * What I do not/have is a reasonable portable means
481 * The solution here, is based on these suggestions.
482 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
485 union worse_case_align {
491 #define ALIGN_SIZE (sizeof(union worse_case_align))
493 /* The alignment process. */
494 size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
499 while ((*p_page)->next)
500 p_page = &((*p_page)->next);
501 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
502 p_page = &((*p_page)->next);
507 *p_page = malloc(sizeof(cmd_queue_page_t));
509 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
510 (*p_page)->next = NULL;
513 offset = (*p_page)->used;
514 (*p_page)->used += size;
516 t=(u8 *)((*p_page)->address);
520 void cmd_queue_free(void)
522 cmd_queue_page_t *page = cmd_queue_pages;
526 cmd_queue_page_t *last = page;
532 cmd_queue_pages = NULL;
536 * Copy a scan_field_t for insertion into the queue.
538 * This allocates a new copy of out_value using cmd_queue_alloc.
540 static void cmd_queue_scan_field_clone(scan_field_t * dst, const scan_field_t * src)
543 dst->num_bits = src->num_bits;
544 dst->out_value = buf_cpy(src->out_value, cmd_queue_alloc(CEIL(src->num_bits, 8)), src->num_bits);
545 dst->in_value = src->in_value;
549 static void jtag_prelude1(void)
553 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
554 jtag_error=ERROR_JTAG_TRST_ASSERTED;
558 if (cmd_queue_end_state == TAP_RESET)
559 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
562 static void jtag_prelude(tap_state_t state)
566 if (state != TAP_INVALID)
567 jtag_add_end_state(state);
569 cmd_queue_cur_state = cmd_queue_end_state;
572 void jtag_add_ir_scan_noverify(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
577 retval=interface_jtag_add_ir_scan(in_num_fields, in_fields, cmd_queue_end_state);
578 if (retval!=ERROR_OK)
585 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
587 * If the input field list contains an instruction value for a TAP then that is used
588 * otherwise the TAP is set to bypass.
590 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
593 void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
595 if (jtag_verify&&jtag_verify_capture_ir)
597 /* 8 x 32 bit id's is enough for all invoations */
599 for (int j = 0; j < in_num_fields; j++)
601 in_fields[j].check_value=NULL;
602 in_fields[j].check_mask=NULL;
603 /* if we are to run a verification of the ir scan, we need to get the input back.
604 * We may have to allocate space if the caller didn't ask for the input back.
606 in_fields[j].check_value=in_fields[j].tap->expected;
607 in_fields[j].check_mask=in_fields[j].tap->expected_mask;
609 jtag_add_scan_check(jtag_add_ir_scan_noverify, in_num_fields, in_fields, state);
612 jtag_add_ir_scan_noverify(in_num_fields, in_fields, state);
617 * see jtag_add_ir_scan()
620 int MINIDRIVER(interface_jtag_add_ir_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
622 size_t num_taps = jtag_NumEnabledTaps();
624 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
625 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
626 scan_field_t * out_fields = cmd_queue_alloc(num_taps * sizeof(scan_field_t));
628 jtag_queue_command(cmd);
630 cmd->type = JTAG_SCAN;
631 cmd->cmd.scan = scan;
633 scan->ir_scan = true;
634 scan->num_fields = num_taps; /* one field per device */
635 scan->fields = out_fields;
636 scan->end_state = state;
639 scan_field_t * field = out_fields; /* keep track where we insert data */
641 /* loop over all enabled TAPs */
643 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
645 /* search the input field list for fields for the current TAP */
649 for (int j = 0; j < in_num_fields; j++)
651 if (tap != in_fields[j].tap)
654 /* if TAP is listed in input fields, copy the value */
660 assert(in_fields[j].num_bits == tap->ir_length); /* input fields must have the same length as the TAP's IR */
662 cmd_queue_scan_field_clone(field, in_fields + j);
669 /* if a TAP isn't listed in input fields, set it to BYPASS */
674 field->num_bits = tap->ir_length;
675 field->out_value = buf_set_ones(cmd_queue_alloc(CEIL(tap->ir_length, 8)), tap->ir_length);
676 field->in_value = NULL; /* do not collect input for tap's in bypass */
679 /* update device information */
680 buf_cpy(field->out_value, tap->cur_instr, tap->ir_length);
685 assert(field == out_fields + num_taps); /* paranoia: jtag_NumEnabledTaps() and jtag_NextEnabledTap() not in sync */
691 * Duplicate the scan fields passed into the function into an IR SCAN command
693 * This function assumes that the caller handles extra fields for bypassed TAPs
696 void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
702 retval=interface_jtag_add_plain_ir_scan(in_num_fields, in_fields, cmd_queue_end_state);
703 if (retval!=ERROR_OK)
709 * see jtag_add_plain_ir_scan()
712 int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
715 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
716 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
717 scan_field_t * out_fields = cmd_queue_alloc(in_num_fields * sizeof(scan_field_t));
719 jtag_queue_command(cmd);
721 cmd->type = JTAG_SCAN;
722 cmd->cmd.scan = scan;
724 scan->ir_scan = true;
725 scan->num_fields = in_num_fields;
726 scan->fields = out_fields;
727 scan->end_state = state;
729 for (int i = 0; i < in_num_fields; i++)
730 cmd_queue_scan_field_clone(out_fields + i, in_fields + i);
737 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
739 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
741 return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
744 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
745 int in_num_fields, scan_field_t *in_fields, tap_state_t state)
747 for (int i = 0; i < in_num_fields; i++)
749 in_fields[i].allocated = 0;
750 in_fields[i].modified = 0;
751 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value == NULL))
753 in_fields[i].modified = 1;
754 /* we need storage space... */
755 #ifdef HAVE_JTAG_MINIDRIVER_H
756 if (in_fields[i].num_bits <= 32)
758 /* This is enough space and we're executing this synchronously */
759 in_fields[i].in_value = in_fields[i].intmp;
762 in_fields[i].in_value = (u8 *)malloc(CEIL(in_fields[i].num_bits, 8));
763 in_fields[i].allocated = 1;
766 in_fields[i].in_value = (u8 *)cmd_queue_alloc(CEIL(in_fields[i].num_bits, 8));
771 jtag_add_scan(in_num_fields, in_fields, state);
773 for (int i = 0; i < in_num_fields; i++)
775 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
777 /* this is synchronous for a minidriver */
778 jtag_add_callback4(jtag_check_value_mask_callback, in_fields[i].in_value,
779 (jtag_callback_data_t)in_fields[i].check_value,
780 (jtag_callback_data_t)in_fields[i].check_mask,
781 (jtag_callback_data_t)in_fields[i].num_bits);
783 if (in_fields[i].allocated)
785 free(in_fields[i].in_value);
787 if (in_fields[i].modified)
789 in_fields[i].in_value = NULL;
794 void jtag_add_dr_scan_check(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
798 jtag_add_scan_check(jtag_add_dr_scan, in_num_fields, in_fields, state);
801 jtag_add_dr_scan(in_num_fields, in_fields, state);
807 * Generate a DR SCAN using the fields passed to the function
809 * For not bypassed TAPs the function checks in_fields and uses fields specified there.
810 * For bypassed TAPs the function generates a dummy 1bit field.
812 * The bypass status of TAPs is set by jtag_add_ir_scan().
815 void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
821 retval=interface_jtag_add_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
822 if (retval!=ERROR_OK)
828 * see jtag_add_dr_scan()
831 int MINIDRIVER(interface_jtag_add_dr_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
833 /* count devices in bypass */
835 size_t bypass_devices = 0;
837 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
843 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
844 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
845 scan_field_t * out_fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(scan_field_t));
847 jtag_queue_command(cmd);
849 cmd->type = JTAG_SCAN;
850 cmd->cmd.scan = scan;
852 scan->ir_scan = false;
853 scan->num_fields = in_num_fields + bypass_devices;
854 scan->fields = out_fields;
855 scan->end_state = state;
858 scan_field_t * field = out_fields; /* keep track where we insert data */
860 /* loop over all enabled TAPs */
862 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
864 /* if TAP is not bypassed insert matching input fields */
868 scan_field_t * start_field = field; /* keep initial position for assert() */
870 for (int j = 0; j < in_num_fields; j++)
872 if (tap != in_fields[j].tap)
875 cmd_queue_scan_field_clone(field, in_fields + j);
880 assert(field > start_field); /* must have at least one input field per not bypassed TAP */
883 /* if a TAP is bypassed, generated a dummy bit*/
888 field->out_value = NULL;
889 field->in_value = NULL;
895 assert(field == out_fields + scan->num_fields); /* no superfluous input fields permitted */
903 * Generate a DR SCAN using the array of output values passed to the function
905 * This function assumes that the parameter target_tap specifies the one TAP
906 * that is not bypassed. All other TAPs must be bypassed and the function will
907 * generate a dummy 1bit field for them.
909 * For the target_tap a sequence of output-only fields will be generated where
910 * each field has the size num_bits and the field's values are taken from
913 * The bypass status of TAPs is set by jtag_add_ir_scan().
916 void MINIDRIVER(interface_jtag_add_dr_out)(jtag_tap_t *target_tap,
920 tap_state_t end_state)
922 /* count devices in bypass */
924 size_t bypass_devices = 0;
926 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
933 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
934 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
935 scan_field_t * out_fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(scan_field_t));
937 jtag_queue_command(cmd);
939 cmd->type = JTAG_SCAN;
940 cmd->cmd.scan = scan;
942 scan->ir_scan = false;
943 scan->num_fields = in_num_fields + bypass_devices;
944 scan->fields = out_fields;
945 scan->end_state = end_state;
948 bool target_tap_match = false;
950 scan_field_t * field = out_fields; /* keep track where we insert data */
952 /* loop over all enabled TAPs */
954 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
956 /* if TAP is not bypassed insert matching input fields */
960 assert(tap == target_tap); /* target_tap must match the one not bypassed TAP */
962 target_tap_match = true;
964 for (int j = 0; j < in_num_fields; j++)
967 size_t scan_size = num_bits[j];
968 buf_set_u32(out_value, 0, scan_size, value[j]);
971 field->num_bits = scan_size;
972 field->out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
973 field->in_value = NULL;
979 /* if a TAP is bypassed, generated a dummy bit*/
985 field->out_value = NULL;
986 field->in_value = NULL;
992 assert(target_tap_match); /* target_tap should be enabled and not bypassed */
997 * Duplicate the scan fields passed into the function into a DR SCAN command
999 * This function assumes that the caller handles extra fields for bypassed TAPs
1002 void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
1006 jtag_prelude(state);
1008 retval=interface_jtag_add_plain_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
1009 if (retval!=ERROR_OK)
1015 * see jtag_add_plain_dr_scan()
1018 int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
1020 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1021 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
1022 scan_field_t * out_fields = cmd_queue_alloc(in_num_fields * sizeof(scan_field_t));
1024 jtag_queue_command(cmd);
1026 cmd->type = JTAG_SCAN;
1027 cmd->cmd.scan = scan;
1029 scan->ir_scan = false;
1030 scan->num_fields = in_num_fields;
1031 scan->fields = out_fields;
1032 scan->end_state = state;
1034 for (int i = 0; i < in_num_fields; i++)
1035 cmd_queue_scan_field_clone(out_fields + i, in_fields + i);
1041 void jtag_add_tlr(void)
1043 jtag_prelude(TAP_RESET);
1046 retval=interface_jtag_add_tlr();
1047 if (retval!=ERROR_OK)
1051 int MINIDRIVER(interface_jtag_add_tlr)(void)
1053 tap_state_t state = TAP_RESET;
1055 /* allocate memory for a new list member */
1056 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1058 jtag_queue_command(cmd);
1060 cmd->type = JTAG_STATEMOVE;
1062 cmd->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1063 cmd->cmd.statemove->end_state = state;
1068 void jtag_add_pathmove(int num_states, const tap_state_t *path)
1070 tap_state_t cur_state = cmd_queue_cur_state;
1074 /* the last state has to be a stable state */
1075 if (!tap_is_state_stable(path[num_states - 1]))
1077 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
1081 for (i=0; i<num_states; i++)
1083 if (path[i] == TAP_RESET)
1085 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
1089 if ( tap_state_transition(cur_state, true) != path[i]
1090 && tap_state_transition(cur_state, false) != path[i])
1092 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
1095 cur_state = path[i];
1100 retval = interface_jtag_add_pathmove(num_states, path);
1101 cmd_queue_cur_state = path[num_states - 1];
1102 if (retval!=ERROR_OK)
1106 int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, const tap_state_t *path)
1108 /* allocate memory for a new list member */
1109 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1111 jtag_queue_command(cmd);
1113 cmd->type = JTAG_PATHMOVE;
1115 cmd->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
1116 cmd->cmd.pathmove->num_states = num_states;
1117 cmd->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);
1119 for (int i = 0; i < num_states; i++)
1120 cmd->cmd.pathmove->path[i] = path[i];
1125 int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, tap_state_t state)
1127 /* allocate memory for a new list member */
1128 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1130 jtag_queue_command(cmd);
1132 cmd->type = JTAG_RUNTEST;
1134 cmd->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
1135 cmd->cmd.runtest->num_cycles = num_cycles;
1136 cmd->cmd.runtest->end_state = state;
1141 void jtag_add_runtest(int num_cycles, tap_state_t state)
1145 jtag_prelude(state);
1147 /* executed by sw or hw fifo */
1148 retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
1149 if (retval!=ERROR_OK)
1154 int MINIDRIVER(interface_jtag_add_clocks)( int num_cycles )
1156 /* allocate memory for a new list member */
1157 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1159 jtag_queue_command(cmd);
1161 cmd->type = JTAG_STABLECLOCKS;
1163 cmd->cmd.stableclocks = cmd_queue_alloc(sizeof(stableclocks_command_t));
1164 cmd->cmd.stableclocks->num_cycles = num_cycles;
1169 void jtag_add_clocks( int num_cycles )
1173 if( !tap_is_state_stable(cmd_queue_cur_state) )
1175 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
1176 tap_state_name(cmd_queue_cur_state) );
1177 jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
1181 if( num_cycles > 0 )
1185 retval = interface_jtag_add_clocks(num_cycles);
1186 if (retval != ERROR_OK)
1191 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
1193 int trst_with_tlr = 0;
1196 /* FIX!!! there are *many* different cases here. A better
1197 * approach is needed for legal combinations of transitions...
1199 if ((jtag_reset_config & RESET_HAS_SRST)&&
1200 (jtag_reset_config & RESET_HAS_TRST)&&
1201 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
1203 if (((req_tlr_or_trst&&!jtag_trst)||
1204 (!req_tlr_or_trst&&jtag_trst))&&
1205 ((req_srst&&!jtag_srst)||
1206 (!req_srst&&jtag_srst)))
1208 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
1209 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
1213 /* Make sure that jtag_reset_config allows the requested reset */
1214 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
1215 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
1217 LOG_ERROR("BUG: requested reset would assert trst");
1218 jtag_error=ERROR_FAIL;
1222 /* if TRST pulls SRST, we reset with TAP T-L-R */
1223 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
1228 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
1230 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
1231 jtag_error=ERROR_FAIL;
1235 if (req_tlr_or_trst)
1237 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
1249 jtag_srst = req_srst;
1251 retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
1252 if (retval!=ERROR_OK)
1257 jtag_execute_queue();
1261 LOG_DEBUG("SRST line asserted");
1265 LOG_DEBUG("SRST line released");
1266 if (jtag_nsrst_delay)
1267 jtag_add_sleep(jtag_nsrst_delay * 1000);
1272 LOG_DEBUG("JTAG reset with RESET instead of TRST");
1273 jtag_add_end_state(TAP_RESET);
1275 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1281 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1282 * and inform possible listeners about this
1284 LOG_DEBUG("TRST line asserted");
1285 tap_set_state(TAP_RESET);
1286 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1290 if (jtag_ntrst_delay)
1291 jtag_add_sleep(jtag_ntrst_delay * 1000);
1295 int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
1297 /* allocate memory for a new list member */
1298 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1300 jtag_queue_command(cmd);
1302 cmd->type = JTAG_RESET;
1304 cmd->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
1305 cmd->cmd.reset->trst = req_trst;
1306 cmd->cmd.reset->srst = req_srst;
1311 void jtag_add_end_state(tap_state_t state)
1313 cmd_queue_end_state = state;
1314 if ((cmd_queue_end_state == TAP_DRSHIFT)||(cmd_queue_end_state == TAP_IRSHIFT))
1316 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
1320 int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
1322 /* allocate memory for a new list member */
1323 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1325 jtag_queue_command(cmd);
1327 cmd->type = JTAG_SLEEP;
1329 cmd->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
1330 cmd->cmd.sleep->us = us;
1335 void jtag_add_sleep(u32 us)
1337 keep_alive(); /* we might be running on a very slow JTAG clk */
1338 int retval=interface_jtag_add_sleep(us);
1339 if (retval!=ERROR_OK)
1344 int jtag_scan_size(const scan_command_t *cmd)
1349 /* count bits in scan command */
1350 for (i = 0; i < cmd->num_fields; i++)
1352 bit_count += cmd->fields[i].num_bits;
1358 int jtag_build_buffer(const scan_command_t *cmd, u8 **buffer)
1363 bit_count = jtag_scan_size(cmd);
1364 *buffer = calloc(1,CEIL(bit_count, 8));
1368 #ifdef _DEBUG_JTAG_IO_
1369 LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
1372 for (i = 0; i < cmd->num_fields; i++)
1374 if (cmd->fields[i].out_value)
1376 #ifdef _DEBUG_JTAG_IO_
1377 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);
1379 buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
1380 #ifdef _DEBUG_JTAG_IO_
1381 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
1387 #ifdef _DEBUG_JTAG_IO_
1388 LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
1392 bit_count += cmd->fields[i].num_bits;
1395 #ifdef _DEBUG_JTAG_IO_
1396 //LOG_DEBUG("bit_count totalling: %i", bit_count );
1402 int jtag_read_buffer(u8 *buffer, const scan_command_t *cmd)
1408 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1411 for (i = 0; i < cmd->num_fields; i++)
1413 /* if neither in_value nor in_handler
1414 * are specified we don't have to examine this field
1416 if (cmd->fields[i].in_value)
1418 int num_bits = cmd->fields[i].num_bits;
1419 u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
1421 #ifdef _DEBUG_JTAG_IO_
1422 char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1423 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
1427 if (cmd->fields[i].in_value)
1429 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
1434 bit_count += cmd->fields[i].num_bits;
1440 static const char *jtag_tap_name(const jtag_tap_t *tap)
1442 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
1445 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
1447 int retval = ERROR_OK;
1449 int compare_failed = 0;
1452 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
1454 compare_failed = buf_cmp(captured, in_check_value, num_bits);
1456 if (compare_failed){
1457 /* An error handler could have caught the failing check
1458 * only report a problem when there wasn't a handler, or if the handler
1459 * acknowledged the error
1462 LOG_WARNING("TAP %s:",
1463 jtag_tap_name(field->tap));
1467 char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1468 char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1472 char *in_check_mask_char;
1473 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1474 LOG_WARNING("value captured during scan didn't pass the requested check:");
1475 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1476 captured_char, in_check_value_char, in_check_mask_char);
1477 free(in_check_mask_char);
1481 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);
1484 free(captured_char);
1485 free(in_check_value_char);
1487 retval = ERROR_JTAG_QUEUE_FAILED;
1494 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
1496 assert(field->in_value != NULL);
1500 /* no checking to do */
1504 jtag_execute_queue_noclear();
1506 int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
1507 jtag_set_error(retval);
1512 enum scan_type jtag_scan_type(const scan_command_t *cmd)
1517 for (i = 0; i < cmd->num_fields; i++)
1519 if (cmd->fields[i].in_value)
1521 if (cmd->fields[i].out_value)
1529 #ifndef HAVE_JTAG_MINIDRIVER_H
1530 /* add callback to end of queue */
1531 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)
1533 struct jtag_callback_entry *entry=cmd_queue_alloc(sizeof(struct jtag_callback_entry));
1536 entry->callback=callback;
1542 if (jtag_callback_queue_head==NULL)
1544 jtag_callback_queue_head=entry;
1545 jtag_callback_queue_tail=entry;
1548 jtag_callback_queue_tail->next=entry;
1549 jtag_callback_queue_tail=entry;
1554 static int jtag_convert_to_callback4(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
1556 ((jtag_callback1_t)data1)(in);
1560 void jtag_add_callback(jtag_callback1_t callback, u8 *in)
1562 jtag_add_callback4(jtag_convert_to_callback4, in, (jtag_callback_data_t)callback, 0, 0);
1566 #ifndef HAVE_JTAG_MINIDRIVER_H
1568 int interface_jtag_execute_queue(void)
1574 LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
1578 retval = jtag->execute_queue();
1580 if (retval == ERROR_OK)
1582 struct jtag_callback_entry *entry;
1583 for (entry=jtag_callback_queue_head; entry!=NULL; entry=entry->next)
1585 retval=entry->callback(entry->in, entry->data1, entry->data2, entry->data3);
1586 if (retval!=ERROR_OK)
1593 jtag_callback_queue_head = NULL;
1594 jtag_callback_queue_tail = NULL;
1596 jtag_command_queue = NULL;
1597 last_command_pointer = &jtag_command_queue;
1603 void jtag_execute_queue_noclear(void)
1605 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
1606 * E.g. a JTAG over TCP/IP or USB....
1608 jtag_flush_queue_count++;
1610 int retval=interface_jtag_execute_queue();
1611 /* we keep the first error */
1612 if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
1618 int jtag_execute_queue(void)
1621 jtag_execute_queue_noclear();
1623 jtag_error=ERROR_OK;
1627 int jtag_reset_callback(enum jtag_event event, void *priv)
1629 jtag_tap_t *tap = priv;
1633 if (event == JTAG_TRST_ASSERTED)
1635 buf_set_ones(tap->cur_instr, tap->ir_length);
1642 void jtag_sleep(u32 us)
1644 alive_sleep(us/1000);
1647 /* Try to examine chain layout according to IEEE 1149.1 §12
1649 int jtag_examine_chain(void)
1653 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1656 int device_count = 0;
1657 u8 zero_check = 0x0;
1658 u8 one_check = 0xff;
1661 field.num_bits = sizeof(idcode_buffer) * 8;
1662 field.out_value = idcode_buffer;
1664 field.in_value = idcode_buffer;
1669 for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1671 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1674 jtag_add_plain_dr_scan(1, &field, TAP_RESET);
1675 jtag_execute_queue();
1677 for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1679 zero_check |= idcode_buffer[i];
1680 one_check &= idcode_buffer[i];
1683 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1684 if ((zero_check == 0x00) || (one_check == 0xff))
1686 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1687 return ERROR_JTAG_INIT_FAILED;
1690 /* point at the 1st tap */
1691 tap = jtag_NextEnabledTap(NULL);
1693 LOG_ERROR("JTAG: No taps enabled?");
1694 return ERROR_JTAG_INIT_FAILED;
1697 for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1699 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1700 if ((idcode & 1) == 0)
1702 /* LSB must not be 0, this indicates a device in bypass */
1703 LOG_WARNING("Tap/Device does not have IDCODE");
1714 /* some devices, such as AVR will output all 1's instead of TDI
1715 input value at end of chain. */
1716 if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1719 /* End of chain (invalid manufacturer ID)
1721 * The JTAG examine is the very first thing that happens
1723 * A single JTAG device requires only 64 bits to be read back correctly.
1725 * The code below adds a check that the rest of the data scanned (640 bits)
1726 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1728 * earlier and gives more helpful/explicit error messages.
1730 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1732 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1733 if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1735 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1743 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1744 manufacturer = EXTRACT_MFG(idcode);
1745 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1746 part = EXTRACT_PART(idcode);
1747 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1748 version = EXTRACT_VER(idcode);
1750 LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1751 ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1752 idcode, manufacturer, part, version);
1758 tap->idcode = idcode;
1760 if (tap->expected_ids_cnt > 0) {
1761 /* Loop over the expected identification codes and test for a match */
1763 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1764 if( tap->idcode == tap->expected_ids[ii] ){
1769 /* If none of the expected ids matched, log an error */
1770 if (ii == tap->expected_ids_cnt) {
1771 LOG_ERROR("JTAG tap: %s got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1774 EXTRACT_MFG( tap->idcode ),
1775 EXTRACT_PART( tap->idcode ),
1776 EXTRACT_VER( tap->idcode ) );
1777 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1778 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1781 tap->expected_ids_cnt,
1782 tap->expected_ids[ii],
1783 EXTRACT_MFG( tap->expected_ids[ii] ),
1784 EXTRACT_PART( tap->expected_ids[ii] ),
1785 EXTRACT_VER( tap->expected_ids[ii] ) );
1788 return ERROR_JTAG_INIT_FAILED;
1790 LOG_INFO("JTAG Tap/device matched");
1794 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1798 tap = jtag_NextEnabledTap(tap);
1803 /* see if number of discovered devices matches configuration */
1804 if (device_count != jtag_NumEnabledTaps())
1806 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1807 device_count, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1808 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1809 return ERROR_JTAG_INIT_FAILED;
1815 int jtag_validate_chain(void)
1818 int total_ir_length = 0;
1824 total_ir_length = 0;
1826 tap = jtag_NextEnabledTap(tap);
1830 total_ir_length += tap->ir_length;
1833 total_ir_length += 2;
1834 ir_test = malloc(CEIL(total_ir_length, 8));
1835 buf_set_ones(ir_test, total_ir_length);
1838 field.num_bits = total_ir_length;
1839 field.out_value = ir_test;
1840 field.in_value = ir_test;
1843 jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1844 jtag_execute_queue();
1850 tap = jtag_NextEnabledTap(tap);
1855 val = buf_get_u32(ir_test, chain_pos, 2);
1858 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1859 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);
1862 return ERROR_JTAG_INIT_FAILED;
1864 chain_pos += tap->ir_length;
1867 val = buf_get_u32(ir_test, chain_pos, 2);
1870 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1871 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);
1874 return ERROR_JTAG_INIT_FAILED;
1882 enum jtag_tap_cfg_param {
1886 static Jim_Nvp nvp_config_opts[] = {
1887 { .name = "-event", .value = JCFG_EVENT },
1889 { .name = NULL, .value = -1 }
1892 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1898 /* parse config or cget options */
1899 while (goi->argc > 0) {
1900 Jim_SetEmptyResult (goi->interp);
1902 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1904 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1910 if (goi->argc == 0) {
1911 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1915 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1917 Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1921 if (goi->isconfigure) {
1922 if (goi->argc != 1) {
1923 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1927 if (goi->argc != 0) {
1928 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1934 jtag_tap_event_action_t *jteap;
1936 jteap = tap->event_action;
1937 /* replace existing? */
1939 if (jteap->event == (enum jtag_tap_event)n->value) {
1942 jteap = jteap->next;
1945 if (goi->isconfigure) {
1946 if (jteap == NULL) {
1948 jteap = calloc(1, sizeof (*jteap));
1950 jteap->event = n->value;
1951 Jim_GetOpt_Obj( goi, &o);
1953 Jim_DecrRefCount(interp, jteap->body);
1955 jteap->body = Jim_DuplicateObj(goi->interp, o);
1956 Jim_IncrRefCount(jteap->body);
1958 /* add to head of event list */
1959 jteap->next = tap->event_action;
1960 tap->event_action = jteap;
1961 Jim_SetEmptyResult(goi->interp);
1964 if (jteap == NULL) {
1965 Jim_SetEmptyResult(goi->interp);
1967 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1974 } /* while (goi->argc) */
1979 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1989 const Jim_Nvp opts[] = {
1990 #define NTAP_OPT_IRLEN 0
1991 { .name = "-irlen" , .value = NTAP_OPT_IRLEN },
1992 #define NTAP_OPT_IRMASK 1
1993 { .name = "-irmask" , .value = NTAP_OPT_IRMASK },
1994 #define NTAP_OPT_IRCAPTURE 2
1995 { .name = "-ircapture" , .value = NTAP_OPT_IRCAPTURE },
1996 #define NTAP_OPT_ENABLED 3
1997 { .name = "-enable" , .value = NTAP_OPT_ENABLED },
1998 #define NTAP_OPT_DISABLED 4
1999 { .name = "-disable" , .value = NTAP_OPT_DISABLED },
2000 #define NTAP_OPT_EXPECTED_ID 5
2001 { .name = "-expected-id" , .value = NTAP_OPT_EXPECTED_ID },
2002 { .name = NULL , .value = -1 },
2005 pTap = malloc( sizeof(jtag_tap_t) );
2006 memset( pTap, 0, sizeof(*pTap) );
2008 Jim_SetResult_sprintf( goi->interp, "no memory");
2012 * we expect CHIP + TAP + OPTIONS
2014 if( goi->argc < 3 ){
2015 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
2018 Jim_GetOpt_String( goi, &cp, NULL );
2019 pTap->chip = strdup(cp);
2021 Jim_GetOpt_String( goi, &cp, NULL );
2022 pTap->tapname = strdup(cp);
2024 /* name + dot + name + null */
2025 x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
2027 sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
2028 pTap->dotted_name = cp;
2030 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
2031 pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
2033 /* default is enabled */
2036 /* deal with options */
2037 #define NTREQ_IRLEN 1
2038 #define NTREQ_IRCAPTURE 2
2039 #define NTREQ_IRMASK 4
2041 /* clear them as we find them */
2042 reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
2045 e = Jim_GetOpt_Nvp( goi, opts, &n );
2047 Jim_GetOpt_NvpUnknown( goi, opts, 0 );
2050 LOG_DEBUG("Processing option: %s", n->name );
2052 case NTAP_OPT_ENABLED:
2055 case NTAP_OPT_DISABLED:
2058 case NTAP_OPT_EXPECTED_ID:
2060 u32 *new_expected_ids;
2062 e = Jim_GetOpt_Wide( goi, &w );
2064 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
2068 new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
2069 if (new_expected_ids == NULL) {
2070 Jim_SetResult_sprintf( goi->interp, "no memory");
2074 memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
2076 new_expected_ids[pTap->expected_ids_cnt] = w;
2078 free(pTap->expected_ids);
2079 pTap->expected_ids = new_expected_ids;
2080 pTap->expected_ids_cnt++;
2083 case NTAP_OPT_IRLEN:
2084 case NTAP_OPT_IRMASK:
2085 case NTAP_OPT_IRCAPTURE:
2086 e = Jim_GetOpt_Wide( goi, &w );
2088 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
2091 if( (w < 0) || (w > 0xffff) ){
2093 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
2094 n->name, (int)(w), (int)(w));
2098 case NTAP_OPT_IRLEN:
2099 pTap->ir_length = w;
2100 reqbits &= (~(NTREQ_IRLEN));
2102 case NTAP_OPT_IRMASK:
2103 pTap->ir_capture_mask = w;
2104 reqbits &= (~(NTREQ_IRMASK));
2106 case NTAP_OPT_IRCAPTURE:
2107 pTap->ir_capture_value = w;
2108 reqbits &= (~(NTREQ_IRCAPTURE));
2111 } /* switch(n->value) */
2112 } /* while( goi->argc ) */
2114 /* Did we get all the options? */
2117 Jim_SetResult_sprintf( goi->interp,
2118 "newtap: %s missing required parameters",
2120 /* TODO: Tell user what is missing :-( */
2121 /* no memory leaks pelase */
2122 free(((void *)(pTap->expected_ids)));
2123 free(((void *)(pTap->chip)));
2124 free(((void *)(pTap->tapname)));
2125 free(((void *)(pTap->dotted_name)));
2126 free(((void *)(pTap)));
2130 pTap->expected = malloc( pTap->ir_length );
2131 pTap->expected_mask = malloc( pTap->ir_length );
2132 pTap->cur_instr = malloc( pTap->ir_length );
2134 buf_set_u32( pTap->expected,
2137 pTap->ir_capture_value );
2138 buf_set_u32( pTap->expected_mask,
2141 pTap->ir_capture_mask );
2142 buf_set_ones( pTap->cur_instr,
2147 jtag_register_event_callback(jtag_reset_callback, pTap );
2149 ppTap = &(jtag_all_taps);
2150 while( (*ppTap) != NULL ){
2151 ppTap = &((*ppTap)->next_tap);
2155 static int n_taps = 0;
2156 pTap->abs_chain_position = n_taps++;
2158 LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
2159 (*ppTap)->dotted_name,
2160 (*ppTap)->abs_chain_position,
2161 (*ppTap)->ir_length,
2162 (*ppTap)->ir_capture_value,
2163 (*ppTap)->ir_capture_mask );
2168 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
2174 struct command_context_s *context;
2178 JTAG_CMD_INIT_RESET,
2181 JTAG_CMD_TAPDISABLE,
2182 JTAG_CMD_TAPISENABLED,
2187 const Jim_Nvp jtag_cmds[] = {
2188 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
2189 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
2190 { .name = "newtap" , .value = JTAG_CMD_NEWTAP },
2191 { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED },
2192 { .name = "tapenable" , .value = JTAG_CMD_TAPENABLE },
2193 { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE },
2194 { .name = "configure" , .value = JTAG_CMD_CONFIGURE },
2195 { .name = "cget" , .value = JTAG_CMD_CGET },
2197 { .name = NULL, .value = -1 },
2200 context = Jim_GetAssocData(interp, "context");
2201 /* go past the command */
2202 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
2204 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
2206 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
2209 Jim_SetEmptyResult( goi.interp );
2211 case JTAG_CMD_INTERFACE:
2212 /* return the name of the interface */
2213 /* TCL code might need to know the exact type... */
2214 /* FUTURE: we allow this as a means to "set" the interface. */
2215 if( goi.argc != 0 ){
2216 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2219 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
2221 case JTAG_CMD_INIT_RESET:
2222 if( goi.argc != 0 ){
2223 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2226 e = jtag_init_reset(context);
2227 if( e != ERROR_OK ){
2228 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
2232 case JTAG_CMD_NEWTAP:
2233 return jim_newtap_cmd( &goi );
2235 case JTAG_CMD_TAPISENABLED:
2236 case JTAG_CMD_TAPENABLE:
2237 case JTAG_CMD_TAPDISABLE:
2238 if( goi.argc != 1 ){
2239 Jim_SetResultString( goi.interp, "Too many parameters",-1 );
2245 t = jtag_TapByJimObj( goi.interp, goi.argv[0] );
2250 case JTAG_CMD_TAPISENABLED:
2253 case JTAG_CMD_TAPENABLE:
2254 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
2258 case JTAG_CMD_TAPDISABLE:
2259 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
2264 Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
2271 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
2278 Jim_GetOpt_Obj(&goi, &o);
2279 t = jtag_TapByJimObj( goi.interp, o );
2284 goi.isconfigure = 0;
2285 return jtag_tap_configure_cmd( &goi, t);
2289 case JTAG_CMD_CONFIGURE:
2291 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
2298 Jim_GetOpt_Obj(&goi, &o);
2299 t = jtag_TapByJimObj( goi.interp, o );
2304 goi.isconfigure = 1;
2305 return jtag_tap_configure_cmd( &goi, t);
2312 int jtag_register_commands(struct command_context_s *cmd_ctx)
2314 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
2316 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
2317 COMMAND_CONFIG, "try to configure interface");
2318 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
2319 COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)");
2320 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
2321 COMMAND_ANY, "set maximum jtag speed (if supported); "
2322 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
2323 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
2324 COMMAND_CONFIG, "jtag_device <ir_length> <ir_expected> <ir_mask>");
2325 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
2327 "[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]");
2328 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
2329 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
2330 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
2331 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
2333 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
2334 COMMAND_EXEC, "print current scan chain configuration");
2336 register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
2337 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
2338 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
2339 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
2340 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
2341 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
2342 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
2343 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
2344 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
2345 register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
2347 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
2348 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
2349 register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
2350 COMMAND_ANY, "verify value capture <enable|disable>");
2351 register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command,
2352 COMMAND_ANY, "choose short(default) or long tms_sequence <short|long>");
2356 int jtag_interface_init(struct command_context_s *cmd_ctx)
2361 if (!jtag_interface)
2363 /* nothing was previously specified by "interface" command */
2364 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
2365 return ERROR_JTAG_INVALID_INTERFACE;
2369 jtag_interface->khz(speed_khz, &jtag_speed);
2373 if (jtag_interface->init() != ERROR_OK)
2374 return ERROR_JTAG_INIT_FAILED;
2376 jtag = jtag_interface;
2380 static int jtag_init_inner(struct command_context_s *cmd_ctx)
2385 LOG_DEBUG("Init JTAG chain");
2387 tap = jtag_NextEnabledTap(NULL);
2389 LOG_ERROR("There are no enabled taps?");
2390 return ERROR_JTAG_INIT_FAILED;
2394 if ((retval=jtag_execute_queue())!=ERROR_OK)
2397 /* examine chain first, as this could discover the real chain layout */
2398 if (jtag_examine_chain() != ERROR_OK)
2400 LOG_ERROR("trying to validate configured JTAG chain anyway...");
2403 if (jtag_validate_chain() != ERROR_OK)
2405 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
2411 int jtag_interface_quit(void)
2413 if (!jtag || !jtag->quit)
2416 // close the JTAG interface
2417 int result = jtag->quit();
2418 if (ERROR_OK != result)
2419 LOG_ERROR("failed: %d", result);
2425 int jtag_init_reset(struct command_context_s *cmd_ctx)
2429 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2432 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
2434 /* Reset can happen after a power cycle.
2436 * Ideally we would only assert TRST or run RESET before the target reset.
2438 * However w/srst_pulls_trst, trst is asserted together with the target
2439 * reset whether we want it or not.
2441 * NB! Some targets have JTAG circuitry disabled until a
2442 * trst & srst has been asserted.
2444 * NB! here we assume nsrst/ntrst delay are sufficient!
2446 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
2449 jtag_add_reset(1, 0); /* RESET or TRST */
2450 if (jtag_reset_config & RESET_HAS_SRST)
2452 jtag_add_reset(1, 1);
2453 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
2454 jtag_add_reset(0, 1);
2456 jtag_add_reset(0, 0);
2457 if ((retval = jtag_execute_queue()) != ERROR_OK)
2460 /* Check that we can communication on the JTAG chain + eventually we want to
2461 * be able to perform enumeration only after OpenOCD has started
2462 * telnet and GDB server
2464 * That would allow users to more easily perform any magic they need to before
2467 return jtag_init_inner(cmd_ctx);
2470 int jtag_init(struct command_context_s *cmd_ctx)
2473 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2475 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
2479 return jtag_init_reset(cmd_ctx);
2482 static int default_khz(int khz, int *jtag_speed)
2484 LOG_ERROR("Translation from khz to jtag_speed not implemented");
2488 static int default_speed_div(int speed, int *khz)
2490 LOG_ERROR("Translation from jtag_speed to khz not implemented");
2494 static int default_power_dropout(int *dropout)
2496 *dropout=0; /* by default we can't detect power dropout */
2500 static int default_srst_asserted(int *srst_asserted)
2502 *srst_asserted=0; /* by default we can't detect srst asserted */
2506 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2511 /* check whether the interface is already configured */
2514 LOG_WARNING("Interface already configured, ignoring");
2518 /* interface name is a mandatory argument */
2519 if (argc < 1 || args[0][0] == '\0')
2521 return ERROR_COMMAND_SYNTAX_ERROR;
2524 for (i=0; jtag_interfaces[i]; i++)
2526 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
2528 if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
2533 jtag_interface = jtag_interfaces[i];
2535 if (jtag_interface->khz == NULL)
2537 jtag_interface->khz = default_khz;
2539 if (jtag_interface->speed_div == NULL)
2541 jtag_interface->speed_div = default_speed_div;
2543 if (jtag_interface->power_dropout == NULL)
2545 jtag_interface->power_dropout = default_power_dropout;
2547 if (jtag_interface->srst_asserted == NULL)
2549 jtag_interface->srst_asserted = default_srst_asserted;
2556 /* no valid interface was found (i.e. the configuration option,
2557 * didn't match one of the compiled-in interfaces
2559 LOG_ERROR("No valid jtag interface found (%s)", args[0]);
2560 LOG_ERROR("compiled-in jtag interfaces:");
2561 for (i = 0; jtag_interfaces[i]; i++)
2563 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
2566 return ERROR_JTAG_INVALID_INTERFACE;
2569 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2573 Jim_Obj *newargs[ 10 ];
2576 * argv[-1] = command
2577 * argv[ 0] = ir length
2578 * argv[ 1] = ir capture
2579 * argv[ 2] = ir mask
2580 * argv[ 3] = not actually used by anything but in the docs
2584 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2587 command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2588 command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2592 command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2593 command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2594 command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2595 command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
2597 newargs[0] = Jim_NewStringObj( interp, "jtag", -1 );
2598 newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
2599 sprintf( buf, "chip%d", jtag_NumTotalTaps() );
2600 newargs[2] = Jim_NewStringObj( interp, buf, -1 );
2601 sprintf( buf, "tap%d", jtag_NumTotalTaps() );
2602 newargs[3] = Jim_NewStringObj( interp, buf, -1 );
2603 newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 );
2604 newargs[5] = Jim_NewStringObj( interp, args[0], -1 );
2605 newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 );
2606 newargs[7] = Jim_NewStringObj( interp, args[1], -1 );
2607 newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 );
2608 newargs[9] = Jim_NewStringObj( interp, args[2], -1 );
2610 command_print( cmd_ctx, "NEW COMMAND:");
2611 sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
2612 Jim_GetString( newargs[0], NULL ),
2613 Jim_GetString( newargs[1], NULL ),
2614 Jim_GetString( newargs[2], NULL ),
2615 Jim_GetString( newargs[3], NULL ),
2616 Jim_GetString( newargs[4], NULL ),
2617 Jim_GetString( newargs[5], NULL ),
2618 Jim_GetString( newargs[6], NULL ),
2619 Jim_GetString( newargs[7], NULL ),
2620 Jim_GetString( newargs[8], NULL ),
2621 Jim_GetString( newargs[9], NULL ) );
2623 e = jim_jtag_command( interp, 10, newargs );
2625 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
2630 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2634 tap = jtag_all_taps;
2635 command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
2636 command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
2639 u32 expected, expected_mask, cur_instr, ii;
2640 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
2641 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
2642 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
2644 command_print(cmd_ctx,
2645 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2646 tap->abs_chain_position,
2648 tap->enabled ? 'Y' : 'n',
2650 (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
2656 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
2657 command_print(cmd_ctx, " | | | | 0x%08x | | | | ",
2658 tap->expected_ids[ii]);
2661 tap = tap->next_tap;
2667 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2673 return ERROR_COMMAND_SYNTAX_ERROR;
2675 /* Original versions cared about the order of these tokens:
2676 * reset_config signals [combination [trst_type [srst_type]]]
2677 * They also clobbered the previous configuration even on error.
2679 * Here we don't care about the order, and only change values
2680 * which have been explicitly specified.
2682 for (; argc; argc--, args++) {
2687 m = RESET_HAS_TRST | RESET_HAS_SRST;
2688 if (strcmp(*args, "none") == 0)
2690 else if (strcmp(*args, "trst_only") == 0)
2691 tmp = RESET_HAS_TRST;
2692 else if (strcmp(*args, "srst_only") == 0)
2693 tmp = RESET_HAS_SRST;
2694 else if (strcmp(*args, "trst_and_srst") == 0)
2695 tmp = RESET_HAS_TRST | RESET_HAS_SRST;
2699 LOG_ERROR("extra reset_config %s spec (%s)",
2701 return ERROR_INVALID_ARGUMENTS;
2706 /* combination (options for broken wiring) */
2707 m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2708 if (strcmp(*args, "separate") == 0)
2709 /* separate reset lines - default */;
2710 else if (strcmp(*args, "srst_pulls_trst") == 0)
2711 tmp |= RESET_SRST_PULLS_TRST;
2712 else if (strcmp(*args, "trst_pulls_srst") == 0)
2713 tmp |= RESET_TRST_PULLS_SRST;
2714 else if (strcmp(*args, "combined") == 0)
2715 tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2719 LOG_ERROR("extra reset_config %s spec (%s)",
2720 "combination", *args);
2721 return ERROR_INVALID_ARGUMENTS;
2726 /* trst_type (NOP without HAS_TRST) */
2727 m = RESET_TRST_OPEN_DRAIN;
2728 if (strcmp(*args, "trst_open_drain") == 0)
2729 tmp |= RESET_TRST_OPEN_DRAIN;
2730 else if (strcmp(*args, "trst_push_pull") == 0)
2731 /* push/pull from adapter - default */;
2735 LOG_ERROR("extra reset_config %s spec (%s)",
2736 "trst_type", *args);
2737 return ERROR_INVALID_ARGUMENTS;
2742 /* srst_type (NOP without HAS_SRST) */
2743 m |= RESET_SRST_PUSH_PULL;
2744 if (strcmp(*args, "srst_push_pull") == 0)
2745 tmp |= RESET_SRST_PUSH_PULL;
2746 else if (strcmp(*args, "srst_open_drain") == 0)
2747 /* open drain from adapter - default */;
2751 LOG_ERROR("extra reset_config %s spec (%s)",
2752 "srst_type", *args);
2753 return ERROR_INVALID_ARGUMENTS;
2758 /* caller provided nonsense; fail */
2759 LOG_ERROR("unknown reset_config flag (%s)", *args);
2760 return ERROR_INVALID_ARGUMENTS;
2763 /* Remember the bits which were specified (mask)
2764 * and their new values (new_cfg).
2770 /* clear previous values of those bits, save new values */
2771 jtag_reset_config &= ~mask;
2772 jtag_reset_config |= new_cfg;
2777 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2781 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2786 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
2792 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2796 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2801 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
2807 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2809 int retval=ERROR_OK;
2813 LOG_DEBUG("handle jtag speed");
2816 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2818 /* this command can be called during CONFIG,
2819 * in which case jtag isn't initialized */
2822 retval=jtag->speed(cur_speed);
2824 } else if (argc == 0)
2828 return ERROR_COMMAND_SYNTAX_ERROR;
2830 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2835 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2837 int retval=ERROR_OK;
2838 LOG_DEBUG("handle jtag khz");
2842 speed_khz = strtoul(args[0], NULL, 0);
2846 LOG_DEBUG("have interface set up");
2848 if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
2854 cur_speed = jtag_speed = speed_div1;
2856 retval=jtag->speed(cur_speed);
2865 return ERROR_COMMAND_SYNTAX_ERROR;
2870 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
2876 command_print(cmd_ctx, "RCLK - adaptive");
2879 command_print(cmd_ctx, "%d kHz", speed_khz);
2885 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2891 return ERROR_COMMAND_SYNTAX_ERROR;
2895 state = tap_state_by_name( args[0] );
2897 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2898 return ERROR_COMMAND_SYNTAX_ERROR;
2900 jtag_add_end_state(state);
2901 jtag_execute_queue();
2903 command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
2908 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2915 return ERROR_COMMAND_SYNTAX_ERROR;
2918 if (args[0][0] == '1')
2920 else if (args[0][0] == '0')
2924 return ERROR_COMMAND_SYNTAX_ERROR;
2927 if (args[1][0] == '1')
2929 else if (args[1][0] == '0')
2933 return ERROR_COMMAND_SYNTAX_ERROR;
2936 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2937 return ERROR_JTAG_INIT_FAILED;
2939 jtag_add_reset(trst, srst);
2940 jtag_execute_queue();
2945 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2949 return ERROR_COMMAND_SYNTAX_ERROR;
2952 jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
2953 jtag_execute_queue();
2959 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2962 scan_field_t *fields;
2964 tap_state_t endstate;
2966 if ((argc < 2) || (argc % 2))
2968 return ERROR_COMMAND_SYNTAX_ERROR;
2971 /* optional "-endstate" */
2973 /* at the end of the arguments. */
2975 endstate = cmd_queue_end_state;
2977 /* have at least one pair of numbers. */
2978 /* is last pair the magic text? */
2979 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2982 cpA = args[ argc-1 ];
2983 for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2984 cpS = tap_state_name( endstate );
2985 if( 0 == strcmp( cpA, cpS ) ){
2989 if( endstate >= TAP_NUM_STATES ){
2990 return ERROR_COMMAND_SYNTAX_ERROR;
2992 /* found - remove the last 2 args */
2998 int num_fields = argc / 2;
3000 fields = malloc(sizeof(scan_field_t) * num_fields);
3002 for (i = 0; i < num_fields; i++)
3004 tap = jtag_TapByString( args[i*2] );
3007 command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
3010 int field_size = tap->ir_length;
3011 fields[i].tap = tap;
3012 fields[i].num_bits = field_size;
3013 fields[i].out_value = malloc(CEIL(field_size, 8));
3014 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
3015 fields[i].in_value = NULL;
3018 /* did we have an endstate? */
3019 jtag_add_ir_scan(num_fields, fields, endstate);
3021 int retval=jtag_execute_queue();
3023 for (i = 0; i < num_fields; i++)
3024 free(fields[i].out_value);
3031 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
3034 scan_field_t *fields;
3036 int field_count = 0;
3039 tap_state_t endstate;
3042 * args[2] = num_bits
3043 * args[3] = hex string
3044 * ... repeat num bits and hex string ...
3047 * args[N-2] = "-endstate"
3048 * args[N-1] = statename
3050 if ((argc < 4) || ((argc % 2)!=0))
3052 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
3056 /* assume no endstate */
3057 endstate = cmd_queue_end_state;
3058 /* validate arguments as numbers */
3060 for (i = 2; i < argc; i+=2)
3065 e = Jim_GetLong(interp, args[i], &bits);
3066 /* If valid - try next arg */
3071 /* Not valid.. are we at the end? */
3072 if ( ((i+2) != argc) ){
3073 /* nope, then error */
3077 /* it could be: "-endstate FOO" */
3079 /* get arg as a string. */
3080 cp = Jim_GetString( args[i], NULL );
3081 /* is it the magic? */
3082 if( 0 == strcmp( "-endstate", cp ) ){
3083 /* is the statename valid? */
3084 cp = Jim_GetString( args[i+1], NULL );
3086 /* see if it is a valid state name */
3087 endstate = tap_state_by_name(cp);
3089 /* update the error message */
3090 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
3092 /* valid - so clear the error */
3094 /* and remove the last 2 args */
3099 /* Still an error? */
3101 return e; /* too bad */
3103 } /* validate args */
3105 tap = jtag_TapByJimObj( interp, args[1] );
3110 num_fields=(argc-2)/2;
3111 fields = malloc(sizeof(scan_field_t) * num_fields);
3112 for (i = 2; i < argc; i+=2)
3118 Jim_GetLong(interp, args[i], &bits);
3119 str = Jim_GetString(args[i+1], &len);
3121 fields[field_count].tap = tap;
3122 fields[field_count].num_bits = bits;
3123 fields[field_count].out_value = malloc(CEIL(bits, 8));
3124 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
3125 fields[field_count].in_value = fields[field_count].out_value;
3129 jtag_add_dr_scan(num_fields, fields, endstate);
3131 retval = jtag_execute_queue();
3132 if (retval != ERROR_OK)
3134 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
3139 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
3140 for (i = 2; i < argc; i+=2)
3145 Jim_GetLong(interp, args[i], &bits);
3146 str = buf_to_str(fields[field_count].in_value, bits, 16);
3147 free(fields[field_count].out_value);
3149 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
3154 Jim_SetResult(interp, list);
3162 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
3164 Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_flush_queue_count));
3170 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3174 if (strcmp(args[0], "enable") == 0)
3176 jtag_verify_capture_ir = 1;
3178 else if (strcmp(args[0], "disable") == 0)
3180 jtag_verify_capture_ir = 0;
3183 return ERROR_COMMAND_SYNTAX_ERROR;
3185 } else if (argc != 0)
3187 return ERROR_COMMAND_SYNTAX_ERROR;
3190 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
3195 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3199 if (strcmp(args[0], "enable") == 0)
3203 else if (strcmp(args[0], "disable") == 0)
3208 return ERROR_COMMAND_SYNTAX_ERROR;
3210 } else if (argc != 0)
3212 return ERROR_COMMAND_SYNTAX_ERROR;
3215 command_print(cmd_ctx, "verify jtag capture is %s", (jtag_verify) ? "enabled": "disabled");
3221 int jtag_power_dropout(int *dropout)
3223 return jtag->power_dropout(dropout);
3226 int jtag_srst_asserted(int *srst_asserted)
3228 return jtag->srst_asserted(srst_asserted);
3231 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
3233 jtag_tap_event_action_t * jteap;
3236 jteap = tap->event_action;
3240 if (jteap->event == e) {
3242 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
3245 Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
3246 Jim_GetString(jteap->body, NULL) );
3247 if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
3248 Jim_PrintErrorMessage(interp);
3252 jteap = jteap->next;
3256 LOG_DEBUG( "event %d %s - no action",
3258 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
3262 /*-----<Cable Helper API>---------------------------------------*/
3264 /* these Cable Helper API functions are all documented in the jtag.h header file,
3265 using a Doxygen format. And since Doxygen's configuration file "Doxyfile",
3266 is setup to prefer its docs in the header file, no documentation is here, for
3267 if it were, it would have to be doubly maintained.
3271 * @see tap_set_state() and tap_get_state() accessors.
3272 * Actual name is not important since accessors hide it.
3274 static tap_state_t state_follower = TAP_RESET;
3276 void tap_set_state_impl( tap_state_t new_state )
3278 /* this is the state we think the TAPs are in now, was cur_state */
3279 state_follower = new_state;
3282 tap_state_t tap_get_state()
3284 return state_follower;
3288 * @see tap_set_end_state() and tap_get_end_state() accessors.
3289 * Actual name is not important because accessors hide it.
3291 static tap_state_t end_state_follower = TAP_RESET;
3293 void tap_set_end_state( tap_state_t new_end_state )
3295 /* this is the state we think the TAPs will be in at completion of the
3296 current TAP operation, was end_state
3298 end_state_follower = new_end_state;
3301 tap_state_t tap_get_end_state()
3303 return end_state_follower;
3307 int tap_move_ndx( tap_state_t astate )
3309 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
3315 case TAP_RESET: ndx = 0; break;
3316 case TAP_DRSHIFT: ndx = 2; break;
3317 case TAP_DRPAUSE: ndx = 3; break;
3318 case TAP_IDLE: ndx = 1; break;
3319 case TAP_IRSHIFT: ndx = 4; break;
3320 case TAP_IRPAUSE: ndx = 5; break;
3322 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate) );
3330 /* tap_move[i][j]: tap movement command to go from state i to state j
3331 * 0: Test-Logic-Reset
3338 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
3340 struct tms_sequences
3348 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
3349 * Read the bits from LSBit first to MSBit last (right-to-left).
3351 #define HEX__(n) 0x##n##LU
3354 (((x) & 0x0000000FLU)?(1<<0):0) \
3355 +(((x) & 0x000000F0LU)?(1<<1):0) \
3356 +(((x) & 0x00000F00LU)?(1<<2):0) \
3357 +(((x) & 0x0000F000LU)?(1<<3):0) \
3358 +(((x) & 0x000F0000LU)?(1<<4):0) \
3359 +(((x) & 0x00F00000LU)?(1<<5):0) \
3360 +(((x) & 0x0F000000LU)?(1<<6):0) \
3361 +(((x) & 0xF0000000LU)?(1<<7):0)
3363 #define B8(bits,count) { ((u8)B8__(HEX__(bits))), (count) }
3365 static const struct tms_sequences old_tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3367 /* value clocked to TMS to move from one of six stable states to another.
3368 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
3369 * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
3370 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
3371 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
3377 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3378 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3379 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
3380 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
3381 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
3382 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
3383 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* IRPAUSE */
3388 static const struct tms_sequences short_tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3390 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
3392 OK, I added Peter's version of the state table, and it works OK for
3393 me on MC1322x. I've recreated the jlink portion of patch with this
3394 new state table. His changes to my state table are pretty minor in
3395 terms of total transitions, but Peter feels that his version fixes
3396 some long-standing problems.
3399 I added the bit count into the table, reduced RESET column to 7 bits from 8.
3402 state specific comments:
3403 ------------------------
3404 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
3405 work better on ARM9 with ft2232 driver. (Dick)
3407 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3408 needed on ARM9 with ft2232 driver. (Dick)
3410 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3411 needed on ARM9 with ft2232 driver. (Dick)
3415 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3416 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3417 { B8(1111111,7), B8(0000000,7), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
3418 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
3419 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
3420 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
3421 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
3425 typedef const struct tms_sequences tms_table[6][6];
3427 static tms_table *tms_seqs=&short_tms_seqs;
3429 int tap_get_tms_path( tap_state_t from, tap_state_t to )
3431 return (*tms_seqs)[tap_move_ndx(from)][tap_move_ndx(to)].bits;
3435 int tap_get_tms_path_len( tap_state_t from, tap_state_t to )
3437 return (*tms_seqs)[tap_move_ndx(from)][tap_move_ndx(to)].bit_count;
3441 bool tap_is_state_stable(tap_state_t astate)
3445 /* A switch() is used because it is symbol dependent
3446 (not value dependent like an array), and can also check bounds.
3465 tap_state_t tap_state_transition(tap_state_t cur_state, bool tms)
3467 tap_state_t new_state;
3469 /* A switch is used because it is symbol dependent and not value dependent
3470 like an array. Also it can check for out of range conditions.
3478 new_state = cur_state;
3483 new_state = TAP_DRSELECT;
3486 new_state = TAP_IRSELECT;
3490 new_state = TAP_DREXIT1;
3494 new_state = TAP_DRUPDATE;
3497 new_state = TAP_DREXIT2;
3500 new_state = TAP_RESET;
3504 new_state = TAP_IREXIT1;
3508 new_state = TAP_IRUPDATE;
3511 new_state = TAP_IREXIT2;
3514 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3527 new_state = TAP_IDLE;
3530 new_state = TAP_DRCAPTURE;
3535 new_state = TAP_DRSHIFT;
3539 new_state = TAP_DRPAUSE;
3542 new_state = TAP_IRCAPTURE;
3547 new_state = TAP_IRSHIFT;
3551 new_state = TAP_IRPAUSE;
3554 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3563 const char* tap_state_name(tap_state_t state)
3569 case TAP_RESET: ret = "RESET"; break;
3570 case TAP_IDLE: ret = "RUN/IDLE"; break;
3571 case TAP_DRSELECT: ret = "DRSELECT"; break;
3572 case TAP_DRCAPTURE: ret = "DRCAPTURE"; break;
3573 case TAP_DRSHIFT: ret = "DRSHIFT"; break;
3574 case TAP_DREXIT1: ret = "DREXIT1"; break;
3575 case TAP_DRPAUSE: ret = "DRPAUSE"; break;
3576 case TAP_DREXIT2: ret = "DREXIT2"; break;
3577 case TAP_DRUPDATE: ret = "DRUPDATE"; break;
3578 case TAP_IRSELECT: ret = "IRSELECT"; break;
3579 case TAP_IRCAPTURE: ret = "IRCAPTURE"; break;
3580 case TAP_IRSHIFT: ret = "IRSHIFT"; break;
3581 case TAP_IREXIT1: ret = "IREXIT1"; break;
3582 case TAP_IRPAUSE: ret = "IRPAUSE"; break;
3583 case TAP_IREXIT2: ret = "IREXIT2"; break;
3584 case TAP_IRUPDATE: ret = "IRUPDATE"; break;
3585 default: ret = "???";
3591 static tap_state_t tap_state_by_name( const char *name )
3595 for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
3596 /* be nice to the human */
3597 if( 0 == strcasecmp( name, tap_state_name(x) ) ){
3605 #ifdef _DEBUG_JTAG_IO_
3607 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3608 do { buf[len] = bit ? '1' : '0'; } while(0)
3609 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3610 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3611 tap_state_name(a), tap_state_name(b), astr, bstr)
3613 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
3614 unsigned tap_bits, tap_state_t next_state)
3616 const u8 *tms_buffer;
3617 const u8 *tdi_buffer;
3622 unsigned tap_out_bits;
3626 tap_state_t last_state;
3628 // set startstate (and possibly last, if tap_bits == 0)
3629 last_state = next_state;
3630 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
3632 tms_buffer = (const u8 *)tms_buf;
3633 tdi_buffer = (const u8 *)tdi_buf;
3635 tap_bytes = TAP_SCAN_BYTES(tap_bits);
3636 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
3639 for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
3641 for(cur_bit = 0; cur_bit < 8; cur_bit++)
3643 // make sure we do not run off the end of the buffers
3644 unsigned tap_bit = cur_byte * 8 + cur_bit;
3645 if (tap_bit == tap_bits)
3648 // check and save TMS bit
3649 tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
3650 JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
3652 // use TMS bit to find the next TAP state
3653 next_state = tap_state_transition(last_state, tap_bit);
3655 // check and store TDI bit
3656 tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
3657 JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
3659 // increment TAP bits
3662 // Only show TDO bits on state transitions, or
3663 // after some number of bits in the same state.
3664 if ((next_state == last_state) && (tap_out_bits < 32))
3667 // terminate strings and display state transition
3668 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3669 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3672 last_state = next_state;
3679 // terminate strings and display state transition
3680 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3681 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3684 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
3688 #endif // _DEBUG_JTAG_IO_
3690 #ifndef HAVE_JTAG_MINIDRIVER_H
3691 void jtag_alloc_in_value32(scan_field_t *field)
3693 field->in_value=(u8 *)cmd_queue_alloc(4);
3697 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3701 if (strcmp(args[0], "short") == 0)
3703 tms_seqs=&short_tms_seqs;
3705 else if (strcmp(args[0], "long") == 0)
3707 tms_seqs=&old_tms_seqs;
3710 return ERROR_COMMAND_SYNTAX_ERROR;
3712 } else if (argc != 0)
3714 return ERROR_COMMAND_SYNTAX_ERROR;
3717 command_print(cmd_ctx, "tms sequence is %s", (tms_seqs==&short_tms_seqs) ? "short": "long");
3722 /*-----</Cable Helper API>--------------------------------------*/
3726 * Function jtag_add_statemove
3727 * moves from the current state to the goal \a state. This needs
3728 * to be handled according to the xsvf spec, see the XSTATE command
3731 int jtag_add_statemove(tap_state_t goal_state)
3733 int retval = ERROR_OK;
3735 tap_state_t moves[8];
3736 tap_state_t cur_state = cmd_queue_cur_state;
3741 LOG_DEBUG( "cur_state=%s goal_state=%s",
3742 tap_state_name(cur_state),
3743 tap_state_name(goal_state) );
3746 /* From the XSVF spec, pertaining to XSTATE:
3748 For special states known as stable states (Test-Logic-Reset,
3749 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
3750 predefined TAP state paths when the starting state is a stable state and
3751 when the XSTATE specifies a new stable state (see the STATE command in
3752 the [Ref 5] for the TAP state paths between stable states). For
3753 non-stable states, XSTATE should specify a state that is only one TAP
3754 state transition distance from the current TAP state to avoid undefined
3755 TAP state paths. A sequence of multiple XSTATE commands can be issued to
3756 transition the TAP through a specific state path.
3759 if (goal_state==cur_state )
3760 ; /* nothing to do */
3762 else if( goal_state==TAP_RESET )
3767 else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
3769 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
3770 spec, then this code is not fully conformant to the xsvf spec. This
3771 puts a burden on tap_get_tms_path() function from the xsvf spec.
3772 If in doubt, you should confirm that that burden is being met.
3775 tms_bits = tap_get_tms_path(cur_state, goal_state);
3776 tms_count = tap_get_tms_path_len(cur_state, goal_state);
3778 assert( (unsigned) tms_count < DIM(moves) );
3780 for (i=0; i<tms_count; i++, tms_bits>>=1)
3782 bool bit = tms_bits & 1;
3784 cur_state = tap_state_transition(cur_state, bit);
3785 moves[i] = cur_state;
3788 jtag_add_pathmove(tms_count, moves);
3791 /* else state must be immediately reachable in one clock cycle, and does not
3792 need to be a stable state.
3794 else if( tap_state_transition(cur_state, true) == goal_state
3795 || tap_state_transition(cur_state, false) == goal_state )
3797 /* move a single state */
3798 moves[0] = goal_state;
3799 jtag_add_pathmove( 1, moves );
3804 retval = ERROR_FAIL;