1 /***************************************************************************
2 * Copyright (C) 2009 by Simon Qian <SimonQian@SimonQian.com> *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
18 ***************************************************************************/
20 /* Versaloon is a programming tool for multiple MCUs.
21 * OpenOCD and MSP430 supports are distributed under GPLv2.
22 * You can find it at http://www.SimonQian.com/en/Versaloon.
29 #define INCLUDE_JTAG_INTERFACE_H
35 //#define _VSLLINK_IN_DEBUG_MODE_
37 #define VSLLINK_MODE_NORMAL 0
38 #define VSLLINK_MODE_DMA 1
40 static u16 vsllink_usb_vid;
41 static u16 vsllink_usb_pid;
42 static u8 vsllink_usb_bulkout;
43 static u8 vsllink_usb_bulkin;
44 static u8 vsllink_usb_interface;
45 static u8 vsllink_mode = VSLLINK_MODE_NORMAL;
46 static int VSLLINK_USB_TIMEOUT = 10000;
48 static int VSLLINK_BufferSize = 1024;
50 /* Global USB buffers */
51 static int vsllink_usb_out_buffer_idx;
52 static int vsllink_usb_in_want_length;
53 static u8* vsllink_usb_in_buffer = NULL;
54 static u8* vsllink_usb_out_buffer = NULL;
56 /* Constants for VSLLink command */
57 #define VSLLINK_CMD_CONN 0x80
58 #define VSLLINK_CMD_DISCONN 0x81
59 #define VSLLINK_CMD_SET_SPEED 0x82
60 #define VSLLINK_CMD_SET_PORT 0x90
61 #define VSLLINK_CMD_GET_PORT 0x91
62 #define VSLLINK_CMD_SET_PORTDIR 0x92
63 #define VSLLINK_CMD_HW_JTAGSEQCMD 0xA0
64 #define VSLLINK_CMD_HW_JTAGHLCMD 0xA1
65 #define VSLLINK_CMD_HW_SWDCMD 0xA2
66 #define VSLLINK_CMD_HW_JTAGRAWCMD 0xA3
68 #define VSLLINK_CMDJTAGSEQ_TMSBYTE 0x00
69 #define VSLLINK_CMDJTAGSEQ_TMSCLOCK 0x40
70 #define VSLLINK_CMDJTAGSEQ_SCAN 0x80
72 #define VSLLINK_CMDJTAGSEQ_CMDMSK 0xC0
73 #define VSLLINK_CMDJTAGSEQ_LENMSK 0x3F
75 #define JTAG_PINMSK_SRST (1 << 0)
76 #define JTAG_PINMSK_TRST (1 << 1)
77 #define JTAG_PINMSK_USR1 (1 << 2)
78 #define JTAG_PINMSK_USR2 (1 << 3)
79 #define JTAG_PINMSK_TCK (1 << 4)
80 #define JTAG_PINMSK_TMS (1 << 5)
81 #define JTAG_PINMSK_TDI (1 << 6)
82 #define JTAG_PINMSK_TDO (1 << 7)
85 #define VSLLINK_TAP_MOVE(from, to) VSLLINK_tap_move[tap_move_ndx(from)][tap_move_ndx(to)]
87 /* VSLLINK_tap_move[i][j]: tap movement command to go from state i to state j
95 * SD->SD and SI->SI have to be caught in interface specific code
97 static u8 VSLLINK_tap_move[6][6] =
99 /* TLR RTI SD PD SI PI */
100 {0xff, 0x7f, 0x2f, 0x0a, 0x37, 0x16}, /* TLR */
101 {0xff, 0x00, 0x45, 0x05, 0x4b, 0x0b}, /* RTI */
102 {0xff, 0x61, 0x00, 0x01, 0x0f, 0x2f}, /* SD */
103 {0xfe, 0x60, 0x40, 0x5c, 0x3c, 0x5e}, /* PD */
104 {0xff, 0x61, 0x07, 0x17, 0x00, 0x01}, /* SI */
105 {0xfe, 0x60, 0x38, 0x5c, 0x40, 0x5e} /* PI */
108 typedef struct insert_insignificant_operation
110 unsigned char insert_value;
111 unsigned char insert_position;
112 }insert_insignificant_operation_t;
114 static insert_insignificant_operation_t VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[6][6] =
161 static u8 VSLLINK_BIT_MSK[8] =
163 0x00, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f
169 int length; /* Number of bits to read */
170 scan_command_t *command; /* Corresponding scan command */
172 } pending_scan_result_t;
174 #define MAX_PENDING_SCAN_RESULTS 256
176 static int pending_scan_results_length;
177 static pending_scan_result_t pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
179 /* External interface functions */
180 static int vsllink_execute_queue(void);
181 static int vsllink_speed(int speed);
182 static int vsllink_khz(int khz, int *jtag_speed);
183 static int vsllink_speed_div(int jtag_speed, int *khz);
184 static int vsllink_register_commands(struct command_context_s *cmd_ctx);
185 static int vsllink_init(void);
186 static int vsllink_quit(void);
188 /* CLI command handler functions */
189 static int vsllink_handle_usb_vid_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
190 static int vsllink_handle_usb_pid_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
191 static int vsllink_handle_usb_bulkin_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
192 static int vsllink_handle_usb_bulkout_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
193 static int vsllink_handle_usb_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
194 static int vsllink_handle_mode_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
196 /* Queue command functions */
197 static void vsllink_end_state(tap_state_t state);
198 static void vsllink_state_move_dma(void);
199 static void vsllink_state_move_normal(void);
200 static void (*vsllink_state_move)(void);
201 static void vsllink_path_move_dma(int num_states, tap_state_t *path);
202 static void vsllink_path_move_normal(int num_states, tap_state_t *path);
203 static void (*vsllink_path_move)(int num_states, tap_state_t *path);
204 static void vsllink_runtest(int num_cycles);
205 static void vsllink_stableclocks_dma(int num_cycles, int tms);
206 static void vsllink_stableclocks_normal(int num_cycles, int tms);
207 static void (*vsllink_stableclocks)(int num_cycles, int tms);
208 static void vsllink_scan_dma(bool ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command);
209 static void vsllink_scan_normal(bool ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command);
210 static void (*vsllink_scan)(bool ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command);
211 static void vsllink_reset(int trst, int srst);
212 static void vsllink_simple_command(u8 command);
213 static int vsllink_connect(void);
214 static int vsllink_disconnect(void);
216 /* VSLLink tap buffer functions */
217 static void vsllink_tap_append_step(int tms, int tdi);
218 static void vsllink_tap_init_dma(void);
219 static void vsllink_tap_init_normal(void);
220 static void (*vsllink_tap_init)(void);
221 static int vsllink_tap_execute_dma(void);
222 static int vsllink_tap_execute_normal(void);
223 static int (*vsllink_tap_execute)(void);
224 static void vsllink_tap_ensure_space_dma(int scans, int length);
225 static void vsllink_tap_ensure_space_normal(int scans, int length);
226 static void (*vsllink_tap_ensure_space)(int scans, int length);
227 static void vsllink_tap_append_scan_dma(int length, u8 *buffer, scan_command_t *command);
228 static void vsllink_tap_append_scan_normal(int length, u8 *buffer, scan_command_t *command, int offset);
230 /* VSLLink lowlevel functions */
231 typedef struct vsllink_jtag
233 struct usb_dev_handle* usb_handle;
236 static vsllink_jtag_t *vsllink_usb_open(void);
237 static void vsllink_usb_close(vsllink_jtag_t *vsllink_jtag);
238 static int vsllink_usb_message(vsllink_jtag_t *vsllink_jtag, int out_length, int in_length);
239 static int vsllink_usb_write(vsllink_jtag_t *vsllink_jtag, int out_length);
240 static int vsllink_usb_read(vsllink_jtag_t *vsllink_jtag);
242 #if defined _DEBUG_USB_COMMS_ || defined _DEBUG_JTAG_IO_
243 static void vsllink_debug_buffer(u8 *buffer, int length);
246 static int vsllink_tms_data_len = 0;
247 static u8* vsllink_tms_cmd_pos;
249 static int tap_length = 0;
250 static int tap_buffer_size = 0;
251 static u8 *tms_buffer = NULL;
252 static u8 *tdi_buffer = NULL;
253 static u8 *tdo_buffer = NULL;
256 static vsllink_jtag_t* vsllink_jtag_handle = NULL;
258 /***************************************************************************/
259 /* External interface implementation */
261 jtag_interface_t vsllink_interface =
264 .execute_queue = vsllink_execute_queue,
265 .speed = vsllink_speed,
267 .speed_div = vsllink_speed_div,
268 .register_commands = vsllink_register_commands,
269 .init = vsllink_init,
273 static void reset_command_pointer(void)
275 if (vsllink_mode == VSLLINK_MODE_NORMAL)
277 vsllink_usb_out_buffer[0] = VSLLINK_CMD_HW_JTAGSEQCMD;
278 vsllink_usb_out_buffer_idx = 3;
286 static int vsllink_execute_queue(void)
288 jtag_command_t *cmd = jtag_command_queue;
293 DEBUG_JTAG_IO("--------------------------------- vsllink -------------------------------------");
295 reset_command_pointer();
301 DEBUG_JTAG_IO( "runtest %i cycles, end in %s", cmd->cmd.runtest->num_cycles, \
302 tap_state_name(cmd->cmd.runtest->end_state));
304 if (cmd->cmd.runtest->end_state != TAP_INVALID)
306 vsllink_end_state(cmd->cmd.runtest->end_state);
308 vsllink_runtest(cmd->cmd.runtest->num_cycles);
312 DEBUG_JTAG_IO("statemove end in %s", tap_state_name(cmd->cmd.statemove->end_state));
314 if (cmd->cmd.statemove->end_state != TAP_INVALID)
316 vsllink_end_state(cmd->cmd.statemove->end_state);
318 vsllink_state_move();
322 DEBUG_JTAG_IO("pathmove: %i states, end in %s", \
323 cmd->cmd.pathmove->num_states, \
324 tap_state_name(cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]));
326 vsllink_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path);
330 if (cmd->cmd.scan->end_state != TAP_INVALID)
332 vsllink_end_state(cmd->cmd.scan->end_state);
335 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
336 if (cmd->cmd.scan->ir_scan)
338 DEBUG_JTAG_IO("JTAG Scan write IR(%d bits), end in %s:", scan_size, tap_state_name(cmd->cmd.scan->end_state));
342 DEBUG_JTAG_IO("JTAG Scan write DR(%d bits), end in %s:", scan_size, tap_state_name(cmd->cmd.scan->end_state));
345 #ifdef _DEBUG_JTAG_IO_
346 vsllink_debug_buffer(buffer, (scan_size + 7) >> 3);
349 type = jtag_scan_type(cmd->cmd.scan);
351 vsllink_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size, cmd->cmd.scan);
355 DEBUG_JTAG_IO("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
357 vsllink_tap_execute();
359 if (cmd->cmd.reset->trst == 1)
361 tap_set_state(TAP_RESET);
363 vsllink_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
367 DEBUG_JTAG_IO("sleep %i", cmd->cmd.sleep->us);
368 vsllink_tap_execute();
369 jtag_sleep(cmd->cmd.sleep->us);
372 case JTAG_STABLECLOCKS:
373 DEBUG_JTAG_IO("add %d clocks", cmd->cmd.stableclocks->num_cycles);
374 switch(tap_get_state())
377 // tms should be '1' to stay in TAP_RESET mode
385 // in other mode, tms should be '0'
387 break; /* above stable states are OK */
389 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
390 tap_state_name(tap_get_state()) );
393 vsllink_stableclocks(cmd->cmd.stableclocks->num_cycles, scan_size);
397 LOG_ERROR("BUG: unknown JTAG command type encountered: %d", cmd->type);
403 return vsllink_tap_execute();
406 static int vsllink_speed(int speed)
410 vsllink_usb_out_buffer[0] = VSLLINK_CMD_SET_SPEED;
411 vsllink_usb_out_buffer[1] = (speed >> 0) & 0xff;
412 vsllink_usb_out_buffer[2] = (speed >> 8) & 0xFF;
414 result = vsllink_usb_write(vsllink_jtag_handle, 3);
422 LOG_ERROR("VSLLink setting speed failed (%d)", result);
423 return ERROR_JTAG_DEVICE_ERROR;
429 static int vsllink_khz(int khz, int *jtag_speed)
436 static int vsllink_speed_div(int jtag_speed, int *khz)
443 static int vsllink_init(void)
445 int check_cnt, to_tmp;
447 char version_str[100];
449 vsllink_usb_in_buffer = malloc(VSLLINK_BufferSize);
450 vsllink_usb_out_buffer = malloc(VSLLINK_BufferSize);
451 if ((vsllink_usb_in_buffer == NULL) || (vsllink_usb_out_buffer == NULL))
453 LOG_ERROR("Not enough memory");
457 vsllink_jtag_handle = vsllink_usb_open();
459 if (vsllink_jtag_handle == 0)
461 LOG_ERROR("Can't find USB JTAG Interface! Please check connection and permissions.");
462 return ERROR_JTAG_INIT_FAILED;
464 LOG_DEBUG("vsllink found on %04X:%04X", vsllink_usb_vid, vsllink_usb_pid);
466 to_tmp = VSLLINK_USB_TIMEOUT;
467 VSLLINK_USB_TIMEOUT = 100;
469 while (check_cnt < 5)
471 vsllink_simple_command(0x00);
472 result = vsllink_usb_read(vsllink_jtag_handle);
476 vsllink_usb_in_buffer[result] = 0;
477 VSLLINK_BufferSize = vsllink_usb_in_buffer[0] + (vsllink_usb_in_buffer[1] << 8);
478 strncpy(version_str, (char *)vsllink_usb_in_buffer + 2, sizeof(version_str));
479 LOG_INFO("%s", version_str);
481 // free the pre-alloc memroy
482 free(vsllink_usb_in_buffer);
483 free(vsllink_usb_out_buffer);
484 vsllink_usb_in_buffer = NULL;
485 vsllink_usb_out_buffer = NULL;
488 vsllink_usb_in_buffer = malloc(VSLLINK_BufferSize);
489 vsllink_usb_out_buffer = malloc(VSLLINK_BufferSize);
490 if ((vsllink_usb_in_buffer == NULL) || (vsllink_usb_out_buffer == NULL))
492 LOG_ERROR("Not enough memory");
497 LOG_INFO("buffer size for USB is %d bytes", VSLLINK_BufferSize);
499 // alloc memory for dma mode
500 if (vsllink_mode == VSLLINK_MODE_DMA)
502 tap_buffer_size = (VSLLINK_BufferSize - 3) / 2;
503 tms_buffer = (u8*)malloc(tap_buffer_size);
504 tdi_buffer = (u8*)malloc(tap_buffer_size);
505 tdo_buffer = (u8*)malloc(tap_buffer_size);
506 if ((tms_buffer == NULL) || (tdi_buffer == NULL) || (tdo_buffer == NULL))
508 LOG_ERROR("Not enough memory");
514 vsllink_simple_command(VSLLINK_CMD_DISCONN);
519 // It's dangerout to proced
520 LOG_ERROR("VSLLink initial failed");
523 VSLLINK_USB_TIMEOUT = to_tmp;
525 // connect to vsllink
527 // initialize function pointers
528 if (vsllink_mode == VSLLINK_MODE_NORMAL)
531 vsllink_state_move = vsllink_state_move_normal;
532 vsllink_path_move = vsllink_path_move_normal;
533 vsllink_stableclocks = vsllink_stableclocks_normal;
534 vsllink_scan = vsllink_scan_normal;
536 vsllink_tap_init = vsllink_tap_init_normal;
537 vsllink_tap_execute = vsllink_tap_execute_normal;
538 vsllink_tap_ensure_space = vsllink_tap_ensure_space_normal;
540 LOG_INFO("vsllink run in NORMAL mode");
545 vsllink_state_move = vsllink_state_move_dma;
546 vsllink_path_move = vsllink_path_move_dma;
547 vsllink_stableclocks = vsllink_stableclocks_dma;
548 vsllink_scan = vsllink_scan_dma;
550 vsllink_tap_init = vsllink_tap_init_dma;
551 vsllink_tap_execute = vsllink_tap_execute_dma;
552 vsllink_tap_ensure_space = vsllink_tap_ensure_space_dma;
554 LOG_INFO("vsllink run in DMA mode");
557 // Set SRST and TRST to output, Set USR1 and USR2 to input
558 vsllink_usb_out_buffer[0] = VSLLINK_CMD_SET_PORTDIR;
559 vsllink_usb_out_buffer[1] = JTAG_PINMSK_SRST | JTAG_PINMSK_TRST | JTAG_PINMSK_USR1 | JTAG_PINMSK_USR2;
560 vsllink_usb_out_buffer[2] = JTAG_PINMSK_SRST | JTAG_PINMSK_TRST;
561 if (vsllink_usb_write(vsllink_jtag_handle, 3) != 3)
563 LOG_ERROR("VSLLink USB send data error");
569 LOG_INFO("VSLLink JTAG Interface ready");
576 static int vsllink_quit(void)
578 if ((vsllink_usb_in_buffer != NULL) && (vsllink_usb_out_buffer != NULL))
580 // Set all pins to input
581 vsllink_usb_out_buffer[0] = VSLLINK_CMD_SET_PORTDIR;
582 vsllink_usb_out_buffer[1] = JTAG_PINMSK_SRST | JTAG_PINMSK_TRST | JTAG_PINMSK_USR1 | JTAG_PINMSK_USR2;
583 vsllink_usb_out_buffer[2] = 0;
584 if (vsllink_usb_write(vsllink_jtag_handle, 3) != 3)
586 LOG_ERROR("VSLLink USB send data error");
591 vsllink_disconnect();
592 vsllink_usb_close(vsllink_jtag_handle);
593 vsllink_jtag_handle = NULL;
596 if (vsllink_usb_in_buffer != NULL)
598 free(vsllink_usb_in_buffer);
599 vsllink_usb_in_buffer = NULL;
601 if (vsllink_usb_out_buffer != NULL)
603 free(vsllink_usb_out_buffer);
604 vsllink_usb_out_buffer = NULL;
610 /***************************************************************************/
611 /* Queue command implementations */
612 static int vsllink_disconnect(void)
614 vsllink_simple_command(VSLLINK_CMD_DISCONN);
618 static int vsllink_connect(void)
620 char vsllink_str[100];
622 vsllink_usb_out_buffer[0] = VSLLINK_CMD_CONN;
623 vsllink_usb_out_buffer[1] = vsllink_mode;
624 vsllink_usb_message(vsllink_jtag_handle, 2, 0);
625 if (vsllink_usb_read(vsllink_jtag_handle) > 2)
627 strncpy(vsllink_str, (char *)vsllink_usb_in_buffer + 2, sizeof(vsllink_str));
628 LOG_INFO("%s", vsllink_str);
634 // when vsllink_tms_data_len > 0, vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] is the byte that need to be appended.
635 // length of VSLLINK_CMDJTAGSEQ_TMSBYTE has been set, no need to set it here.
636 static void vsllink_append_tms(void)
638 u8 tms_scan = VSLLINK_TAP_MOVE(tap_get_state(), tap_get_end_state());
640 insert_insignificant_operation_t *insert = \
641 &VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[tap_move_ndx(tap_get_state())][tap_move_ndx(tap_get_end_state())];
643 if (((tap_get_state() != TAP_RESET) && (tap_get_state() != TAP_IDLE) && (tap_get_state() != TAP_DRPAUSE) && (tap_get_state() != TAP_IRPAUSE)) || \
644 (vsllink_tms_data_len <= 0) || (vsllink_tms_data_len >= 8) || \
645 (vsllink_tms_cmd_pos == NULL))
647 LOG_ERROR("There MUST be some bugs in the driver");
651 tms2 = (tms_scan & VSLLINK_BIT_MSK[insert->insert_position]) << \
652 vsllink_tms_data_len;
653 if (insert->insert_value == 1)
655 tms2 |= VSLLINK_BIT_MSK[8 - vsllink_tms_data_len] << \
656 (vsllink_tms_data_len + insert->insert_position);
658 tms2 |= (tms_scan >> insert->insert_position) << \
659 (8 + insert->insert_position);
661 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= (tms2 >> 0) & 0xff;
662 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms2 >> 8) & 0xff;
664 vsllink_tms_data_len = 0;
665 vsllink_tms_cmd_pos = NULL;
668 static void vsllink_end_state(tap_state_t state)
670 if (tap_is_state_stable(state))
672 tap_set_end_state(state);
676 LOG_ERROR("BUG: %i is not a valid end state", state);
681 /* Goes to the end state. */
682 static void vsllink_state_move_normal(void)
684 if (vsllink_tms_data_len > 0)
686 vsllink_append_tms();
690 vsllink_tap_ensure_space(0, 2);
692 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE;
693 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_TAP_MOVE(tap_get_state(), tap_get_end_state());
696 tap_set_state(tap_get_end_state());
698 static void vsllink_state_move_dma(void)
700 int i, insert_length = (tap_length % 8) ? (8 - (tap_length % 8)) : 0;
701 insert_insignificant_operation_t *insert = \
702 &VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[tap_move_ndx(tap_get_state())][tap_move_ndx(tap_get_end_state())];
703 u8 tms_scan = VSLLINK_TAP_MOVE(tap_get_state(), tap_get_end_state());
705 if (tap_get_state() == TAP_RESET)
707 vsllink_tap_ensure_space(0, 8);
709 for (i = 0; i < 8; i++)
711 vsllink_tap_append_step(1, 0);
715 if (insert_length > 0)
717 vsllink_tap_ensure_space(0, 16);
719 for (i = 0; i < insert->insert_position; i++)
721 vsllink_tap_append_step((tms_scan >> i) & 1, 0);
723 for (i = 0; i < insert_length; i++)
725 vsllink_tap_append_step(insert->insert_value, 0);
727 for (i = insert->insert_position; i < 8; i++)
729 vsllink_tap_append_step((tms_scan >> i) & 1, 0);
734 vsllink_tap_ensure_space(0, 8);
736 for (i = 0; i < 8; i++)
738 vsllink_tap_append_step((tms_scan >> i) & 1, 0);
742 tap_set_state(tap_get_end_state());
745 // write tms from current vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx]
746 static void vsllink_add_path(int start, int num, tap_state_t *path)
750 for (i = start; i < (start + num); i++)
756 vsllink_usb_out_buffer_idx++;
758 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = 0;
761 if (path[i - start] == tap_state_transition(tap_get_state(), true))
763 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] |= 1 << (i & 7);
765 else if (path[i - start] == tap_state_transition(tap_get_state(), false))
771 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(path[i]));
774 tap_set_state(path[i - start]);
776 if ((i > 0) && ((i & 7) == 0))
778 vsllink_usb_out_buffer_idx++;
779 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = 0;
782 tap_set_end_state(tap_get_state());
785 static void vsllink_path_move_normal(int num_states, tap_state_t *path)
787 int i, tms_len, tms_cmd_pos, path_idx = 0;
789 if (vsllink_tms_data_len > 0)
791 // there are vsllink_tms_data_len more tms bits to be shifted
792 // so there are vsllink_tms_data_len + num_states tms bits in all
793 tms_len = vsllink_tms_data_len + num_states;
796 // merge into last tms shift
799 // just append tms data to the last tms byte
800 vsllink_add_path(vsllink_tms_data_len, num_states, path);
802 else if (tms_len == 8)
804 // end last tms shift command
805 (*vsllink_tms_cmd_pos)--;
806 vsllink_add_path(vsllink_tms_data_len, num_states, path);
808 else if (tms_len < 16)
810 if ((*vsllink_tms_cmd_pos & VSLLINK_CMDJTAGSEQ_LENMSK) < VSLLINK_CMDJTAGSEQ_LENMSK)
812 // every tms shift command can contain VSLLINK_CMDJTAGSEQ_LENMSK + 1 bytes in most
813 // there is enought tms length in the current tms shift command
814 (*vsllink_tms_cmd_pos)++;
815 vsllink_add_path(vsllink_tms_data_len, num_states, path);
819 // every tms shift command can contain VSLLINK_CMDJTAGSEQ_LENMSK + 1 bytes in most
820 // not enough tms length in the current tms shift command
821 // so a new command should be added
822 // first decrease byte length of last tms shift command
823 (*vsllink_tms_cmd_pos)--;
824 // append tms data to the last tms byte
825 vsllink_add_path(vsllink_tms_data_len, 8 - vsllink_tms_data_len, path);
826 path += 8 - vsllink_tms_data_len;
827 // add new command(3 bytes)
828 vsllink_tap_ensure_space(0, 3);
829 vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx];
830 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | 1;
831 vsllink_add_path(0, num_states - (8 - vsllink_tms_data_len), path);
834 else if (tms_len == 16)
836 // end last tms shift command
837 vsllink_add_path(vsllink_tms_data_len, num_states, path);
840 vsllink_tms_data_len = (vsllink_tms_data_len + num_states) & 7;
841 if (vsllink_tms_data_len == 0)
843 vsllink_tms_cmd_pos = NULL;
849 vsllink_add_path(vsllink_tms_data_len, 16 - vsllink_tms_data_len, path);
851 path += 16 - vsllink_tms_data_len;
852 num_states -= 16 - vsllink_tms_data_len;
853 vsllink_tms_data_len = 0;
854 vsllink_tms_cmd_pos = NULL;
860 // Normal operation, don't need to append tms data
861 vsllink_tms_data_len = num_states & 7;
863 while (num_states > 0)
865 if (num_states > ((VSLLINK_CMDJTAGSEQ_LENMSK + 1) * 8))
867 i = (VSLLINK_CMDJTAGSEQ_LENMSK + 1) * 8;
873 tms_len = (i + 7) >> 3;
874 vsllink_tap_ensure_space(0, tms_len + 2);
875 tms_cmd_pos = vsllink_usb_out_buffer_idx;
876 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | (tms_len - 1);
878 vsllink_add_path(0, i, path + path_idx);
884 if (vsllink_tms_data_len > 0)
886 if (tms_len < (VSLLINK_CMDJTAGSEQ_LENMSK + 1))
888 vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[tms_cmd_pos];
889 (*vsllink_tms_cmd_pos)++;
893 vsllink_usb_out_buffer[tms_cmd_pos]--;
895 tms_len = vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx];
896 vsllink_tap_ensure_space(0, 3);
897 vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx];
898 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | 1;
899 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = tms_len;
904 static void vsllink_path_move_dma(int num_states, tap_state_t *path)
910 if ((8 - (tap_length & 7)) < num_states)
912 j = 8 - (tap_length & 7);
918 for (i = 0; i < j; i++)
920 if (path[i] == tap_state_transition(tap_get_state(), false))
922 vsllink_tap_append_step(0, 0);
924 else if (path[i] == tap_state_transition(tap_get_state(), true))
926 vsllink_tap_append_step(1, 0);
930 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(path[i]));
933 tap_set_state(path[i]);
940 vsllink_tap_ensure_space(0, num_states);
942 for (i = 0; i < num_states; i++)
944 if (path[j + i] == tap_state_transition(tap_get_state(), false))
946 vsllink_tap_append_step(0, 0);
948 else if (path[j + i] == tap_state_transition(tap_get_state(), true))
950 vsllink_tap_append_step(1, 0);
954 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(path[i]));
957 tap_set_state(path[j + i]);
961 tap_set_end_state(tap_get_state());
964 static void vsllink_stableclocks_normal(int num_cycles, int tms)
969 if (vsllink_tms_data_len > 0)
971 // there are vsllink_tms_data_len more tms bits to be shifted
972 // so there are vsllink_tms_data_len + num_cycles tms bits in all
973 tms_len = vsllink_tms_data_len + num_cycles;
976 // append '1' for tms
977 tms_append_byte = (u16)((((1 << num_cycles) - 1) << vsllink_tms_data_len) & 0xFFFF);
981 // append '0' for tms
986 // merge into last tms shift
989 // just add to vsllink_tms_data_len
990 // same result if tun through
991 //vsllink_tms_data_len += num_cycles;
992 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] |= (u8)(tms_append_byte & 0xFF);
994 else if (tms_len == 8)
996 // end last tms shift command
997 // just reduce it, and append last tms byte
998 (*vsllink_tms_cmd_pos)--;
999 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= (u8)(tms_append_byte & 0xFF);
1001 else if (tms_len < 16)
1003 if ((*vsllink_tms_cmd_pos & VSLLINK_CMDJTAGSEQ_LENMSK) < VSLLINK_CMDJTAGSEQ_LENMSK)
1005 // every tms shift command can contain VSLLINK_CMDJTAGSEQ_LENMSK + 1 bytes in most
1006 // there is enought tms length in the current tms shift command
1007 // increase the tms byte length by 1 and set the last byte to 0
1008 (*vsllink_tms_cmd_pos)++;
1009 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= (u8)(tms_append_byte & 0xFF);
1010 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = (u8)(tms_append_byte >> 8);
1014 // every tms shift command can contain VSLLINK_CMDJTAGSEQ_LENMSK + 1 bytes in most
1015 // not enough tms length in the current tms shift command
1016 // so a new command should be added
1017 // first decrease byte length of last tms shift command
1018 (*vsllink_tms_cmd_pos)--;
1019 // append last tms byte and move the command pointer to the next empty position
1020 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= (u8)(tms_append_byte & 0xFF);
1021 // add new command(3 bytes)
1022 vsllink_tap_ensure_space(0, 3);
1023 vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx];
1024 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | 1;
1025 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = (u8)(tms_append_byte >> 8);
1028 else if (tms_len == 16)
1030 // end last tms shift command
1031 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= (u8)(tms_append_byte & 0xFF);
1032 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (u8)(tms_append_byte >> 8);
1035 vsllink_tms_data_len = tms_len & 7;
1036 if (vsllink_tms_data_len == 0)
1038 vsllink_tms_cmd_pos = NULL;
1044 // more shifts will be needed
1045 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= (u8)(tms_append_byte & 0xFF);
1046 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (u8)(tms_append_byte >> 8);
1048 num_cycles -= 16 - vsllink_tms_data_len;
1049 vsllink_tms_data_len = 0;
1050 vsllink_tms_cmd_pos = NULL;
1053 // from here vsllink_tms_data_len == 0 or num_cycles == 0
1055 if (vsllink_tms_data_len > 0)
1061 LOG_ERROR("There MUST be some bugs in the driver");
1067 // get number of bytes left to be sent
1068 tms_len = num_cycles >> 3;
1071 vsllink_tap_ensure_space(1, 5);
1072 // if tms_len > 0, vsllink_tms_data_len == 0
1073 // so just add new command
1074 // LSB of the command byte is the tms value when do the shifting
1077 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSCLOCK | 1;
1081 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSCLOCK;
1083 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms_len >> 0) & 0xff;
1084 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms_len >> 8) & 0xff;
1085 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms_len >> 16) & 0xff;
1086 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms_len >> 24) & 0xff;
1088 vsllink_usb_in_want_length += 1;
1089 pending_scan_results_buffer[pending_scan_results_length].buffer = NULL;
1090 pending_scan_results_length++;
1092 if (tms_len > 0xFFFF)
1094 vsllink_tap_execute();
1099 vsllink_tms_data_len = num_cycles & 7;
1100 if (vsllink_tms_data_len > 0)
1102 vsllink_tap_ensure_space(0, 3);
1103 vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx];
1104 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | 1;
1107 // append '1' for tms
1108 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = (1 << vsllink_tms_data_len) - 1;
1112 // append '0' for tms
1113 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = 0x00;
1118 static void vsllink_stableclocks_dma(int num_cycles, int tms)
1124 if ((8 - (tap_length & 7)) < num_cycles)
1126 cur_cycles = 8 - (tap_length & 7);
1130 cur_cycles = num_cycles;
1132 for (i = 0; i < cur_cycles; i++)
1134 vsllink_tap_append_step(tms, 0);
1136 num_cycles -= cur_cycles;
1139 while (num_cycles > 0)
1141 if (num_cycles > 8 * tap_buffer_size)
1143 cur_cycles = 8 * tap_buffer_size;
1147 cur_cycles = num_cycles;
1150 vsllink_tap_ensure_space(0, cur_cycles);
1152 for (i = 0; i < cur_cycles; i++)
1154 vsllink_tap_append_step(tms, 0);
1157 num_cycles -= cur_cycles;
1161 static void vsllink_runtest(int num_cycles)
1163 tap_state_t saved_end_state = tap_get_end_state();
1165 if (tap_get_state() != TAP_IDLE)
1167 // enter into IDLE state
1168 vsllink_end_state(TAP_IDLE);
1169 vsllink_state_move();
1172 vsllink_stableclocks(num_cycles, 0);
1176 vsllink_end_state(saved_end_state);
1177 tap_set_state(TAP_IDLE);
1178 if (tap_get_end_state() != TAP_IDLE)
1180 vsllink_state_move();
1184 static void vsllink_scan_normal(bool ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command)
1186 tap_state_t saved_end_state;
1187 u8 bits_left, tms_tmp, tdi_len;
1190 if (0 == scan_size )
1195 tdi_len = ((scan_size + 7) >> 3);
1196 if ((tdi_len + 7) > VSLLINK_BufferSize)
1198 LOG_ERROR("Your implementation of VSLLink has not enough buffer");
1202 saved_end_state = tap_get_end_state();
1204 /* Move to appropriate scan state */
1205 vsllink_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
1207 if (vsllink_tms_data_len > 0)
1209 if (tap_get_state() == tap_get_end_state())
1211 // already in IRSHIFT or DRSHIFT state
1212 // merge tms data in the last tms shift command into next scan command
1213 if(*vsllink_tms_cmd_pos < 1)
1215 LOG_ERROR("There MUST be some bugs in the driver");
1218 else if(*vsllink_tms_cmd_pos < 2)
1220 tms_tmp = vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx];
1221 vsllink_usb_out_buffer_idx--;
1225 tms_tmp = vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx];
1226 *vsllink_tms_cmd_pos -= 2;
1229 vsllink_tap_ensure_space(1, tdi_len + 7);
1230 // VSLLINK_CMDJTAGSEQ_SCAN ored by 1 means that tms_before is valid
1231 // which is merged from the last tms shift command
1232 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_SCAN | 1;
1233 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = ((tdi_len + 1) >> 0) & 0xff;
1234 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = ((tdi_len + 1) >> 8) & 0xff;
1235 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = tms_tmp;
1236 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = buffer[0] << (8 - vsllink_tms_data_len);
1238 for (i = 0; i < tdi_len; i++)
1240 buffer[i] >>= 8 - vsllink_tms_data_len;
1243 buffer[i] += buffer[i + 1] << vsllink_tms_data_len;
1247 vsllink_tap_append_scan_normal(scan_size - vsllink_tms_data_len, buffer, command, vsllink_tms_data_len);
1248 scan_size -= 8 - vsllink_tms_data_len;
1249 vsllink_tms_data_len = 0;
1253 vsllink_state_move();
1254 vsllink_tap_ensure_space(1, tdi_len + 5);
1256 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_SCAN;
1257 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tdi_len >> 0) & 0xff;
1258 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tdi_len >> 8) & 0xff;
1260 vsllink_tap_append_scan_normal(scan_size, buffer, command, 0);
1265 vsllink_tap_ensure_space(1, tdi_len + 7);
1267 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_SCAN | 1;
1268 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = ((tdi_len + 1) >> 0) & 0xff;
1269 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = ((tdi_len + 1)>> 8) & 0xff;
1270 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_TAP_MOVE(tap_get_state(), tap_get_end_state());
1271 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0;
1273 vsllink_tap_append_scan_normal(scan_size, buffer, command, 8);
1275 vsllink_end_state(saved_end_state);
1277 bits_left = scan_size & 0x07;
1278 tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
1282 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 1 << (bits_left - 1);
1286 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 1 << 7;
1289 if (tap_get_state() != tap_get_end_state())
1291 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_TAP_MOVE(tap_get_state(), tap_get_end_state());
1295 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0;
1298 tap_set_state(tap_get_end_state());
1300 static void vsllink_scan_dma(bool ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command)
1302 tap_state_t saved_end_state;
1304 saved_end_state = tap_get_end_state();
1306 /* Move to appropriate scan state */
1307 vsllink_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
1309 vsllink_state_move();
1310 vsllink_end_state(saved_end_state);
1313 vsllink_tap_append_scan_dma(scan_size, buffer, command);
1315 tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
1316 while (tap_length % 8 != 0)
1319 vsllink_tap_append_step(0, 0);
1322 if (tap_get_state() != tap_get_end_state())
1324 vsllink_state_move();
1328 static void vsllink_reset(int trst, int srst)
1332 LOG_DEBUG("trst: %i, srst: %i", trst, srst);
1334 /* Signals are active low */
1335 vsllink_usb_out_buffer[0] = VSLLINK_CMD_SET_PORT;
1336 vsllink_usb_out_buffer[1] = JTAG_PINMSK_SRST | JTAG_PINMSK_TRST;
1337 vsllink_usb_out_buffer[2] = 0;
1340 vsllink_usb_out_buffer[2] |= JTAG_PINMSK_SRST;
1344 vsllink_usb_out_buffer[2] |= JTAG_PINMSK_TRST;
1347 result = vsllink_usb_write(vsllink_jtag_handle, 3);
1350 LOG_ERROR("VSLLink command VSLLINK_CMD_SET_PORT failed (%d)", result);
1354 static void vsllink_simple_command(u8 command)
1358 DEBUG_JTAG_IO("0x%02x", command);
1360 vsllink_usb_out_buffer[0] = command;
1361 result = vsllink_usb_write(vsllink_jtag_handle, 1);
1365 LOG_ERROR("VSLLink command 0x%02x failed (%d)", command, result);
1369 static int vsllink_register_commands(struct command_context_s *cmd_ctx)
1371 register_command(cmd_ctx, NULL, "vsllink_usb_vid", vsllink_handle_usb_vid_command,
1372 COMMAND_CONFIG, NULL);
1373 register_command(cmd_ctx, NULL, "vsllink_usb_pid", vsllink_handle_usb_pid_command,
1374 COMMAND_CONFIG, NULL);
1375 register_command(cmd_ctx, NULL, "vsllink_usb_bulkin", vsllink_handle_usb_bulkin_command,
1376 COMMAND_CONFIG, NULL);
1377 register_command(cmd_ctx, NULL, "vsllink_usb_bulkout", vsllink_handle_usb_bulkout_command,
1378 COMMAND_CONFIG, NULL);
1379 register_command(cmd_ctx, NULL, "vsllink_usb_interface", vsllink_handle_usb_interface_command,
1380 COMMAND_CONFIG, NULL);
1381 register_command(cmd_ctx, NULL, "vsllink_mode", vsllink_handle_mode_command,
1382 COMMAND_CONFIG, NULL);
1387 static int vsllink_handle_mode_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1390 LOG_ERROR("parameter error, should be one parameter for VID");
1394 if (!strcmp(args[0], "normal"))
1396 vsllink_mode = VSLLINK_MODE_NORMAL;
1398 else if (!strcmp(args[0], "dma"))
1400 vsllink_mode = VSLLINK_MODE_DMA;
1404 LOG_ERROR("invalid vsllink_mode: %s", args[0]);
1411 static int vsllink_handle_usb_vid_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1415 LOG_ERROR("parameter error, should be one parameter for VID");
1419 vsllink_usb_vid = strtol(args[0], NULL, 0);
1424 static int vsllink_handle_usb_pid_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1428 LOG_ERROR("parameter error, should be one parameter for PID");
1432 vsllink_usb_pid = strtol(args[0], NULL, 0);
1437 static int vsllink_handle_usb_bulkin_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1441 LOG_ERROR("parameter error, should be one parameter for BULKIN endpoint");
1445 vsllink_usb_bulkin = strtol(args[0], NULL, 0) | 0x80;
1450 static int vsllink_handle_usb_bulkout_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1454 LOG_ERROR("parameter error, should be one parameter for BULKOUT endpoint");
1458 vsllink_usb_bulkout = strtol(args[0], NULL, 0);
1463 static int vsllink_handle_usb_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1467 LOG_ERROR("parameter error, should be one parameter for interface number");
1471 vsllink_usb_interface = strtol(args[0], NULL, 0);
1476 /***************************************************************************/
1477 /* VSLLink tap functions */
1479 static void vsllink_tap_init_normal(void)
1481 vsllink_usb_out_buffer_idx = 0;
1482 vsllink_usb_in_want_length = 0;
1483 pending_scan_results_length = 0;
1485 static void vsllink_tap_init_dma(void)
1488 pending_scan_results_length = 0;
1491 static void vsllink_tap_ensure_space_normal(int scans, int length)
1493 int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
1494 int available_bytes = VSLLINK_BufferSize - vsllink_usb_out_buffer_idx;
1496 if (scans > available_scans || length > available_bytes)
1498 vsllink_tap_execute();
1501 static void vsllink_tap_ensure_space_dma(int scans, int length)
1503 int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
1504 int available_bytes = tap_buffer_size * 8 - tap_length;
1506 if (scans > available_scans || length > available_bytes)
1508 vsllink_tap_execute();
1512 static void vsllink_tap_append_step(int tms, int tdi)
1515 int index = tap_length / 8;
1517 if (index < tap_buffer_size)
1519 int bit_index = tap_length % 8;
1520 u8 bit = 1 << bit_index;
1524 tms_buffer[index] |= bit;
1528 tms_buffer[index] &= ~bit;
1533 tdi_buffer[index] |= bit;
1537 tdi_buffer[index] &= ~bit;
1544 LOG_ERROR("buffer overflow, tap_length=%d", tap_length);
1548 static void vsllink_tap_append_scan_normal(int length, u8 *buffer, scan_command_t *command, int offset)
1550 pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length];
1555 vsllink_usb_in_want_length += ((length + 7) >> 3) + 1;
1559 vsllink_usb_in_want_length += (length + 7) >> 3;
1561 pending_scan_result->length = length;
1562 pending_scan_result->offset = offset;
1563 pending_scan_result->command = command;
1564 pending_scan_result->buffer = buffer;
1566 for (i = 0; i < ((length + 7) >> 3); i++)
1568 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = buffer[i];
1571 pending_scan_results_length++;
1573 static void vsllink_tap_append_scan_dma(int length, u8 *buffer, scan_command_t *command)
1575 pending_scan_result_t *pending_scan_result;
1576 int len_tmp, len_all, i;
1579 while (len_all < length)
1581 if ((length - len_all) > tap_buffer_size * 8)
1583 len_tmp = tap_buffer_size * 8;
1587 len_tmp = length - len_all;
1590 vsllink_tap_ensure_space(1, (len_tmp + 7) & ~7);
1592 pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length];
1593 pending_scan_result->offset = tap_length;
1594 pending_scan_result->length = len_tmp;
1595 pending_scan_result->command = command;
1596 pending_scan_result->buffer = buffer + len_all / 8;
1598 for (i = 0; i < len_tmp; i++)
1600 vsllink_tap_append_step(((len_all+i) < length-1 ? 0 : 1), (buffer[(len_all+i)/8] >> ((len_all+i)%8)) & 1);
1603 pending_scan_results_length++;
1608 /* Pad and send a tap sequence to the device, and receive the answer.
1609 * For the purpose of padding we assume that we are in reset or idle or pause state. */
1610 static int vsllink_tap_execute_normal(void)
1616 if (vsllink_tms_data_len > 0)
1618 if((tap_get_state() != TAP_RESET) && (tap_get_state() != TAP_IDLE) && (tap_get_state() != TAP_IRPAUSE) && (tap_get_state() != TAP_DRPAUSE))
1620 LOG_WARNING("%s is not in RESET or IDLE or PAUSR state", tap_state_name(tap_get_state()));
1623 if (vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] & (1 << (vsllink_tms_data_len - 1)))
1625 // last tms bit is '1'
1626 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= 0xFF << vsllink_tms_data_len;
1627 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0xFF;
1628 vsllink_tms_data_len = 0;
1632 // last tms bit is '0'
1633 vsllink_usb_out_buffer_idx++;
1634 vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0;
1635 vsllink_tms_data_len = 0;
1639 if (vsllink_usb_out_buffer_idx > 3)
1641 if (vsllink_usb_out_buffer[0] == VSLLINK_CMD_HW_JTAGSEQCMD)
1643 vsllink_usb_out_buffer[1] = (vsllink_usb_out_buffer_idx >> 0) & 0xff;
1644 vsllink_usb_out_buffer[2] = (vsllink_usb_out_buffer_idx >> 8) & 0xff;
1647 result = vsllink_usb_message(vsllink_jtag_handle, vsllink_usb_out_buffer_idx, vsllink_usb_in_want_length);
1649 if (result == vsllink_usb_in_want_length)
1651 for (i = 0; i < pending_scan_results_length; i++)
1653 pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[i];
1654 u8 *buffer = pending_scan_result->buffer;
1655 int length = pending_scan_result->length;
1656 int offset = pending_scan_result->offset;
1657 scan_command_t *command = pending_scan_result->command;
1661 // IRSHIFT or DRSHIFT
1662 buf_set_buf(vsllink_usb_in_buffer, first * 8 + offset, buffer, 0, length);
1663 first += (length + offset + 7) >> 3;
1665 DEBUG_JTAG_IO("JTAG scan read(%d bits):", length);
1666 #ifdef _DEBUG_JTAG_IO_
1667 vsllink_debug_buffer(buffer, (length + 7) >> 3);
1670 if (jtag_read_buffer(buffer, command) != ERROR_OK)
1673 return ERROR_JTAG_QUEUE_FAILED;
1676 free(pending_scan_result->buffer);
1677 pending_scan_result->buffer = NULL;
1687 LOG_ERROR("vsllink_tap_execute, wrong result %d, expected %d", result, vsllink_usb_in_want_length);
1688 return ERROR_JTAG_QUEUE_FAILED;
1693 reset_command_pointer();
1697 static int vsllink_tap_execute_dma(void)
1705 /* Pad last byte so that tap_length is divisible by 8 */
1706 while (tap_length % 8 != 0)
1708 /* More of the last TMS value keeps us in the same state,
1709 * analogous to free-running JTAG interfaces. */
1710 vsllink_tap_append_step(last_tms, 0);
1712 byte_length = tap_length / 8;
1714 vsllink_usb_out_buffer[0] = VSLLINK_CMD_HW_JTAGRAWCMD;
1715 vsllink_usb_out_buffer[1] = ((byte_length * 2 + 3) >> 0) & 0xff; // package size
1716 vsllink_usb_out_buffer[2] = ((byte_length * 2 + 3) >> 8) & 0xff;
1718 memcpy(&vsllink_usb_out_buffer[3], tdi_buffer, byte_length);
1719 memcpy(&vsllink_usb_out_buffer[3 + byte_length], tms_buffer, byte_length);
1721 result = vsllink_usb_message(vsllink_jtag_handle, 3 + 2 * byte_length, byte_length);
1722 if (result == byte_length)
1724 for (i = 0; i < pending_scan_results_length; i++)
1726 pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[i];
1727 u8 *buffer = pending_scan_result->buffer;
1728 int length = pending_scan_result->length;
1729 int first = pending_scan_result->offset;
1731 scan_command_t *command = pending_scan_result->command;
1732 buf_set_buf(vsllink_usb_in_buffer, first, buffer, 0, length);
1734 DEBUG_JTAG_IO("JTAG scan read(%d bits, from %d bits):", length, first);
1735 #ifdef _DEBUG_JTAG_IO_
1736 vsllink_debug_buffer(buffer, (length + 7) >> 3);
1739 if (jtag_read_buffer(buffer, command) != ERROR_OK)
1742 return ERROR_JTAG_QUEUE_FAILED;
1745 if (pending_scan_result->buffer != NULL)
1747 free(pending_scan_result->buffer);
1753 LOG_ERROR("vsllink_tap_execute, wrong result %d, expected %d", result, byte_length);
1754 return ERROR_JTAG_QUEUE_FAILED;
1763 /*****************************************************************************/
1764 /* VSLLink USB low-level functions */
1766 static vsllink_jtag_t* vsllink_usb_open(void)
1768 struct usb_bus *busses;
1769 struct usb_bus *bus;
1770 struct usb_device *dev;
1773 vsllink_jtag_t *result;
1775 result = (vsllink_jtag_t*) malloc(sizeof(vsllink_jtag_t));
1781 busses = usb_get_busses();
1783 /* find vsllink_jtag device in usb bus */
1785 for (bus = busses; bus; bus = bus->next)
1787 for (dev = bus->devices; dev; dev = dev->next)
1789 if ((dev->descriptor.idVendor == vsllink_usb_vid) && (dev->descriptor.idProduct == vsllink_usb_pid))
1791 result->usb_handle = usb_open(dev);
1792 if (NULL == result->usb_handle)
1794 LOG_ERROR("failed to open %04X:%04X, not enough permissions?", vsllink_usb_vid, vsllink_usb_pid);
1798 /* usb_set_configuration required under win32 */
1799 ret = usb_set_configuration(result->usb_handle, dev->config[0].bConfigurationValue);
1802 LOG_ERROR("fail to set configuration to %d, %d returned, not enough permissions?", dev->config[0].bConfigurationValue, ret);
1805 ret = usb_claim_interface(result->usb_handle, vsllink_usb_interface);
1808 LOG_ERROR("fail to claim interface %d, %d returned", vsllink_usb_interface, ret);
1814 * This makes problems under Mac OS X. And is not needed
1815 * under Windows. Hopefully this will not break a linux build
1817 usb_set_altinterface(result->usb_handle, 0);
1828 static void vsllink_usb_close(vsllink_jtag_t *vsllink_jtag)
1832 ret = usb_release_interface(vsllink_jtag->usb_handle, vsllink_usb_interface);
1835 LOG_ERROR("fail to release interface %d, %d returned", vsllink_usb_interface, ret);
1839 ret = usb_close(vsllink_jtag->usb_handle);
1842 LOG_ERROR("fail to close usb, %d returned", ret);
1849 /* Send a message and receive the reply. */
1850 static int vsllink_usb_message(vsllink_jtag_t *vsllink_jtag, int out_length, int in_length)
1854 result = vsllink_usb_write(vsllink_jtag, out_length);
1855 if (result == out_length)
1859 result = vsllink_usb_read(vsllink_jtag);
1860 if (result == in_length )
1866 LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)", in_length, result);
1874 LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)", out_length, result);
1879 /* Write data from out_buffer to USB. */
1880 static int vsllink_usb_write(vsllink_jtag_t *vsllink_jtag, int out_length)
1884 if (out_length > VSLLINK_BufferSize)
1886 LOG_ERROR("vsllink_jtag_write illegal out_length=%d (max=%d)", out_length, VSLLINK_BufferSize);
1890 result = usb_bulk_write(vsllink_jtag->usb_handle, vsllink_usb_bulkout, \
1891 (char *)vsllink_usb_out_buffer, out_length, VSLLINK_USB_TIMEOUT);
1893 DEBUG_JTAG_IO("vsllink_usb_write, out_length = %d, result = %d", out_length, result);
1895 #ifdef _DEBUG_USB_COMMS_
1896 LOG_DEBUG("USB out:");
1897 vsllink_debug_buffer(vsllink_usb_out_buffer, out_length);
1900 #ifdef _VSLLINK_IN_DEBUG_MODE_
1907 /* Read data from USB into in_buffer. */
1908 static int vsllink_usb_read(vsllink_jtag_t *vsllink_jtag)
1910 int result = usb_bulk_read(vsllink_jtag->usb_handle, vsllink_usb_bulkin, \
1911 (char *)vsllink_usb_in_buffer, VSLLINK_BufferSize, VSLLINK_USB_TIMEOUT);
1913 DEBUG_JTAG_IO("vsllink_usb_read, result = %d", result);
1915 #ifdef _DEBUG_USB_COMMS_
1916 LOG_DEBUG("USB in:");
1917 vsllink_debug_buffer(vsllink_usb_in_buffer, result);
1922 #define BYTES_PER_LINE 16
1924 #if defined _DEBUG_USB_COMMS_ || defined _DEBUG_JTAG_IO_
1925 static void vsllink_debug_buffer(u8 *buffer, int length)
1932 for (i = 0; i < length; i += BYTES_PER_LINE)
1934 snprintf(line, 5, "%04x", i);
1935 for (j = i; j < i + BYTES_PER_LINE && j < length; j++)
1937 snprintf(s, 4, " %02x", buffer[j]);
1940 LOG_DEBUG("%s", line);
1943 #endif // _DEBUG_USB_COMMS_ || _DEBUG_JTAG_IO_