/*************************************************************************** * Copyright (C) 2009 by Simon Qian * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * * (at your option) any later version. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ /* Versaloon is a programming tool for multiple MCUs. * OpenOCD and MSP430 supports are distributed under GPLv2. * You can find it at http://www.SimonQian.com/en/Versaloon. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "replacements.h" #include "jtag.h" #include #include #include "log.h" //#define _VSLLINK_IN_DEBUG_MODE_ /* enable this to view USB communication */ #if 0 #define _DEBUG_USB_COMMS_ #endif #ifdef _DEBUG_JTAG_IO_ #define DEBUG_JTAG_IO(expr ...) LOG_DEBUG(expr) #else #define DEBUG_JTAG_IO(expr ...) #endif u16 vsllink_vid; u16 vsllink_pid; u8 vsllink_bulkout; u8 vsllink_bulkin; #define VSLLINK_USB_TIMEOUT 5000 static int VSLLINK_BufferSize = 1024; /* Global USB buffers */ static int vsllink_usb_out_buffer_idx; static int vsllink_usb_in_want_length; static u8* vsllink_usb_in_buffer = NULL; static u8* vsllink_usb_out_buffer = NULL; /* Constants for VSLLink command */ #define VSLLINK_CMD_CONN 0x80 #define VSLLINK_CMD_DISCONN 0x81 #define VSLLINK_CMD_SET_SPEED 0x82 #define VSLLINK_CMD_SET_PORT 0x90 #define VSLLINK_CMD_GET_PORT 0x91 #define VSLLINK_CMD_SET_PORTDIR 0x92 #define VSLLINK_CMD_HW_JTAGSEQCMD 0xA0 #define VSLLINK_CMD_HW_JTAGHLCMD 0xA1 #define VSLLINK_CMD_HW_SWDCMD 0xA2 #define VSLLINK_CMDJTAGSEQ_TMSBYTE 0x00 #define VSLLINK_CMDJTAGSEQ_TMS0BYTE 0x40 #define VSLLINK_CMDJTAGSEQ_SCAN 0x80 #define VSLLINK_CMDJTAGSEQ_CMDMSK 0xC0 #define VSLLINK_CMDJTAGSEQ_LENMSK 0x3F #define JTAG_PINMSK_SRST (1 << 0) #define JTAG_PINMSK_TRST (1 << 1) #define JTAG_PINMSK_USR1 (1 << 2) #define JTAG_PINMSK_USR2 (1 << 3) #define JTAG_PINMSK_TCK (1 << 4) #define JTAG_PINMSK_TMS (1 << 5) #define JTAG_PINMSK_TDI (1 << 6) #define JTAG_PINMSK_TDO (1 << 7) #define VSLLINK_TAP_MOVE(from, to) VSLLINK_tap_move[tap_move_map[from]][tap_move_map[to]] /* VSLLINK_tap_move[i][j]: tap movement command to go from state i to state j * 0: Test-Logic-Reset * 1: Run-Test/Idle * 2: Shift-DR * 3: Pause-DR * 4: Shift-IR * 5: Pause-IR * * SD->SD and SI->SI have to be caught in interface specific code */ u8 VSLLINK_tap_move[6][6] = { /* TLR RTI SD PD SI PI */ {0xff, 0x7f, 0x2f, 0x0a, 0x37, 0x16}, /* TLR */ {0xff, 0x00, 0x45, 0x05, 0x4b, 0x0b}, /* RTI */ {0xff, 0x61, 0x00, 0x01, 0x0f, 0x2f}, /* SD */ {0xff, 0x60, 0x40, 0x5c, 0x3c, 0x5e}, /* PD */ {0xff, 0x61, 0x07, 0x17, 0x00, 0x01}, /* SI */ {0xff, 0x60, 0x38, 0x5c, 0x40, 0x5e} /* PI */ }; typedef struct insert_insignificant_operation { unsigned char insert_value; unsigned char insert_position; }insert_insignificant_operation_t; insert_insignificant_operation_t VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[6][6] = { /* stuff offset */ {/* TLR */ {1, 0,}, /* TLR */ {1, 0,}, /* RTI */ {1, 0,}, /* SD */ {1, 0,}, /* PD */ {1, 0,}, /* SI */ {1, 0,}}, /* PI */ {/* RTI */ {1, 0,}, /* TLR */ {0, 0,}, /* RTI */ {0, 4,}, /* SD */ {0, 7,}, /* PD */ {0, 5,}, /* SI */ {0, 7,}}, /* PI */ {/* SD */ {0, 0,}, /* TLR */ {0, 0,}, /* RTI */ {0, 0,}, /* SD */ {0, 0,}, /* PD */ {0, 0,}, /* SI */ {0, 0,}}, /* PI */ {/* PD */ {0, 0,}, /* TLR */ {0, 0,}, /* RTI */ {0, 0,}, /* SD */ {0, 0,}, /* PD */ {0, 0,}, /* SI */ {0, 0,}}, /* PI */ {/* SI */ {0, 0,}, /* TLR */ {0, 0,}, /* RTI */ {0, 0,}, /* SD */ {0, 0,}, /* PD */ {0, 0,}, /* SI */ {0, 0,}}, /* PI */ {/* PI */ {0, 0,}, /* TLR */ {0, 0,}, /* RTI */ {0, 0,}, /* SD */ {0, 0,}, /* PD */ {0, 0,}, /* SI */ {0, 0,}}, /* PI */ }; u8 VSLLINK_BIT_MSK[8] = { 0x00, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f }; typedef struct { int length; /* Number of bits to read */ int offset; scan_command_t *command; /* Corresponding scan command */ u8 *buffer; } pending_scan_result_t; #define MAX_PENDING_SCAN_RESULTS 256 static int pending_scan_results_length; static pending_scan_result_t pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS]; /* External interface functions */ int vsllink_execute_queue(void); int vsllink_speed(int speed); int vsllink_khz(int khz, int *jtag_speed); int vsllink_speed_div(int jtag_speed, int *khz); int vsllink_register_commands(struct command_context_s *cmd_ctx); int vsllink_init(void); int vsllink_quit(void); /* CLI command handler functions */ int vsllink_handle_usb_vid_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int vsllink_handle_usb_pid_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int vsllink_handle_usb_bulkin_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int vsllink_handle_usb_bulkout_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); /* Queue command functions */ void vsllink_end_state(enum tap_state state); void vsllink_state_move(void); void vsllink_path_move(int num_states, enum tap_state *path); void vsllink_runtest(int num_cycles); void vsllink_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command); void vsllink_reset(int trst, int srst); void vsllink_simple_command(u8 command); /* VSLLink tap buffer functions */ void vsllink_tap_init(void); int vsllink_tap_execute(void); void vsllink_tap_ensure_space(int scans, int bytes); void vsllink_tap_append_scan(int length, u8 *buffer, scan_command_t *command, int offset); /* VSLLink lowlevel functions */ typedef struct vsllink_jtag { struct usb_dev_handle* usb_handle; } vsllink_jtag_t; vsllink_jtag_t *vsllink_usb_open(void); void vsllink_usb_close(vsllink_jtag_t *vsllink_jtag); int vsllink_usb_message(vsllink_jtag_t *vsllink_jtag, int out_length, int in_length); int vsllink_usb_write(vsllink_jtag_t *vsllink_jtag, int out_length); int vsllink_usb_read(vsllink_jtag_t *vsllink_jtag); void vsllink_debug_buffer(u8 *buffer, int length); static int vsllink_tms_data_len = 0; static u8* vsllink_tms_cmd_pos; vsllink_jtag_t* vsllink_jtag_handle; /***************************************************************************/ /* External interface implementation */ jtag_interface_t vsllink_interface = { .name = "vsllink", .execute_queue = vsllink_execute_queue, .speed = vsllink_speed, .khz = vsllink_khz, .speed_div = vsllink_speed_div, .register_commands = vsllink_register_commands, .init = vsllink_init, .quit = vsllink_quit }; int vsllink_execute_queue(void) { jtag_command_t *cmd = jtag_command_queue; int scan_size; enum scan_type type; u8 *buffer; DEBUG_JTAG_IO("--------------------------------------------------------------------------------"); vsllink_usb_out_buffer[0] = VSLLINK_CMD_HW_JTAGSEQCMD; vsllink_usb_out_buffer_idx = 3; while (cmd != NULL) { switch (cmd->type) { case JTAG_END_STATE: DEBUG_JTAG_IO("end_state: %s", jtag_state_name(cmd->cmd.end_state->end_state)); if (cmd->cmd.end_state->end_state != -1) { vsllink_end_state(cmd->cmd.end_state->end_state); } break; case JTAG_RUNTEST: DEBUG_JTAG_IO( "runtest %i cycles, end in %s", cmd->cmd.runtest->num_cycles, \ jtag_state_name(cmd->cmd.runtest->end_state)); if (cmd->cmd.runtest->end_state != -1) { vsllink_end_state(cmd->cmd.runtest->end_state); } vsllink_runtest(cmd->cmd.runtest->num_cycles); break; case JTAG_STATEMOVE: DEBUG_JTAG_IO("statemove end in %s", jtag_state_name(cmd->cmd.statemove->end_state)); if (cmd->cmd.statemove->end_state != -1) { vsllink_end_state(cmd->cmd.statemove->end_state); } vsllink_state_move(); break; case JTAG_PATHMOVE: DEBUG_JTAG_IO("pathmove: %i states, end in %s", \ cmd->cmd.pathmove->num_states, \ jtag_state_name(cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1])); vsllink_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path); break; case JTAG_SCAN: if (cmd->cmd.scan->end_state != -1) { vsllink_end_state(cmd->cmd.scan->end_state); } scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer); if (cmd->cmd.scan->ir_scan) { DEBUG_JTAG_IO("JTAG Scan write IR(%d bits), end in %s:", scan_size, jtag_state_name(cmd->cmd.scan->end_state)); } else { DEBUG_JTAG_IO("JTAG Scan write DR(%d bits), end in %s:", scan_size, jtag_state_name(cmd->cmd.scan->end_state)); } #ifdef _DEBUG_JTAG_IO_ vsllink_debug_buffer(buffer, (scan_size + 7) >> 3); #endif type = jtag_scan_type(cmd->cmd.scan); vsllink_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size, cmd->cmd.scan); break; case JTAG_RESET: DEBUG_JTAG_IO("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst); vsllink_tap_execute(); if (cmd->cmd.reset->trst == 1) { cur_state = TAP_RESET; } vsllink_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst); vsllink_usb_out_buffer[0] = VSLLINK_CMD_HW_JTAGSEQCMD; vsllink_usb_out_buffer_idx = 3; break; case JTAG_SLEEP: DEBUG_JTAG_IO("sleep %i", cmd->cmd.sleep->us); vsllink_tap_execute(); jtag_sleep(cmd->cmd.sleep->us); break; default: LOG_ERROR("BUG: unknown JTAG command type encountered"); exit(-1); } cmd = cmd->next; } return vsllink_tap_execute(); } int vsllink_speed(int speed) { int result; vsllink_usb_out_buffer[0] = VSLLINK_CMD_SET_SPEED; vsllink_usb_out_buffer[1] = (speed >> 0) & 0xff; vsllink_usb_out_buffer[2] = (speed >> 8) & 0xFF; result = vsllink_usb_write(vsllink_jtag_handle, 3); if (result == 3) { return ERROR_OK; } else { LOG_ERROR("VSLLink setting speed failed (%d)", result); return ERROR_JTAG_DEVICE_ERROR; } return ERROR_OK; } int vsllink_khz(int khz, int *jtag_speed) { *jtag_speed = khz; return ERROR_OK; } int vsllink_speed_div(int jtag_speed, int *khz) { *khz = jtag_speed; return ERROR_OK; } int vsllink_register_commands(struct command_context_s *cmd_ctx) { register_command(cmd_ctx, NULL, "vsllink_usb_vid", vsllink_handle_usb_vid_command, COMMAND_CONFIG, NULL); register_command(cmd_ctx, NULL, "vsllink_usb_pid", vsllink_handle_usb_pid_command, COMMAND_CONFIG, NULL); register_command(cmd_ctx, NULL, "vsllink_usb_bulkin", vsllink_handle_usb_bulkin_command, COMMAND_CONFIG, NULL); register_command(cmd_ctx, NULL, "vsllink_usb_bulkout", vsllink_handle_usb_bulkout_command, COMMAND_CONFIG, NULL); return ERROR_OK; } int vsllink_init(void) { int check_cnt; int result; char version_str[100]; vsllink_usb_in_buffer = malloc(VSLLINK_BufferSize); vsllink_usb_out_buffer = malloc(VSLLINK_BufferSize); if ((vsllink_usb_in_buffer == NULL) || (vsllink_usb_out_buffer == NULL)) { LOG_ERROR("Not enough memory"); exit(-1); } vsllink_jtag_handle = vsllink_usb_open(); if (vsllink_jtag_handle == 0) { LOG_ERROR("Can't find USB JTAG Interface! Please check connection and permissions."); return ERROR_JTAG_INIT_FAILED; } check_cnt = 0; while (check_cnt < 3) { vsllink_simple_command(VSLLINK_CMD_CONN); result = vsllink_usb_read(vsllink_jtag_handle); if (result > 2) { vsllink_usb_in_buffer[result] = 0; VSLLINK_BufferSize = vsllink_usb_in_buffer[0] + (vsllink_usb_in_buffer[1] << 8); strncpy(version_str, (char *)vsllink_usb_in_buffer + 2, sizeof(version_str)); LOG_INFO(version_str); // free the pre-alloc memroy free(vsllink_usb_in_buffer); free(vsllink_usb_out_buffer); vsllink_usb_in_buffer = NULL; vsllink_usb_out_buffer = NULL; // alloc new memory vsllink_usb_in_buffer = malloc(VSLLINK_BufferSize); vsllink_usb_out_buffer = malloc(VSLLINK_BufferSize); if ((vsllink_usb_in_buffer == NULL) || (vsllink_usb_out_buffer == NULL)) { LOG_ERROR("Not enough memory"); exit(-1); } else { LOG_INFO("buffer size for USB is %d bytes", VSLLINK_BufferSize); } break; } vsllink_simple_command(VSLLINK_CMD_DISCONN); check_cnt++; } if (check_cnt == 3) { // It's dangerout to proced LOG_ERROR("VSLLink initial failed"); exit(-1); } // Set SRST and TRST to output, Set USR1 and USR2 to input vsllink_usb_out_buffer[0] = VSLLINK_CMD_SET_PORTDIR; vsllink_usb_out_buffer[1] = JTAG_PINMSK_SRST | JTAG_PINMSK_TRST | JTAG_PINMSK_USR1 | JTAG_PINMSK_USR2; vsllink_usb_out_buffer[2] = JTAG_PINMSK_SRST | JTAG_PINMSK_TRST; if (vsllink_usb_write(vsllink_jtag_handle, 3) != 3) { LOG_ERROR("VSLLink USB send data error"); exit(-1); } vsllink_reset(0, 0); LOG_INFO("VSLLink JTAG Interface ready"); vsllink_tap_init(); return ERROR_OK; } int vsllink_quit(void) { if ((vsllink_usb_in_buffer != NULL) && (vsllink_usb_out_buffer != NULL)) { // Set all pins to input vsllink_usb_out_buffer[0] = VSLLINK_CMD_SET_PORTDIR; vsllink_usb_out_buffer[1] = JTAG_PINMSK_SRST | JTAG_PINMSK_TRST | JTAG_PINMSK_USR1 | JTAG_PINMSK_USR2; vsllink_usb_out_buffer[2] = 0; if (vsllink_usb_write(vsllink_jtag_handle, 3) != 3) { LOG_ERROR("VSLLink USB send data error"); exit(-1); } // disconnect vsllink_simple_command(VSLLINK_CMD_DISCONN); vsllink_usb_close(vsllink_jtag_handle); } if (vsllink_usb_in_buffer != NULL) { free(vsllink_usb_in_buffer); } if (vsllink_usb_out_buffer != NULL) { free(vsllink_usb_out_buffer); } return ERROR_OK; } // when vsllink_tms_data_len > 0, vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] is the byte that need to be appended. // length of VSLLINK_CMDJTAGSEQ_TMSBYTE has been set, no need to set it here. void vsllink_append_tms(void) { u8 tms_scan = VSLLINK_TAP_MOVE(cur_state, end_state); u16 tms2; if (((cur_state != TAP_RESET) && (cur_state != TAP_IDLE) && (cur_state != TAP_DRPAUSE) && (cur_state != TAP_IRPAUSE)) || \ (vsllink_tms_data_len <= 0) || (vsllink_tms_data_len >= 8) || \ (vsllink_tms_cmd_pos == NULL)) { LOG_ERROR("There MUST be some bugs in the driver"); exit(-1); } tms2 = (tms_scan & VSLLINK_BIT_MSK[VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[tap_move_map[cur_state]][tap_move_map[end_state]].insert_position]) << \ vsllink_tms_data_len; if (VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[tap_move_map[cur_state]][tap_move_map[end_state]].insert_value == 1) { tms2 |= VSLLINK_BIT_MSK[8 - vsllink_tms_data_len] << \ (vsllink_tms_data_len + VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[tap_move_map[cur_state]][tap_move_map[end_state]].insert_position); } tms2 |= (tms_scan >> VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[tap_move_map[cur_state]][tap_move_map[end_state]].insert_position) << \ (8 + VSLLINK_TAP_MOVE_INSERT_INSIGNIFICANT[tap_move_map[cur_state]][tap_move_map[end_state]].insert_position); vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= (tms2 >> 0) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms2 >> 8) & 0xff; vsllink_tms_data_len = 0; vsllink_tms_cmd_pos = NULL; } /***************************************************************************/ /* Queue command implementations */ void vsllink_end_state(enum tap_state state) { if (tap_move_map[state] != -1) { end_state = state; } else { LOG_ERROR("BUG: %i is not a valid end state", state); exit(-1); } } /* Goes to the end state. */ void vsllink_state_move(void) { if (vsllink_tms_data_len > 0) { vsllink_append_tms(); } else { vsllink_tap_ensure_space(0, 2); vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_TAP_MOVE(cur_state, end_state); } cur_state = end_state; } // write tms from current vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] void vsllink_add_path(int start, int num, enum tap_state *path) { int i; for (i = start; i < (start + num); i++) { if ((i & 7) == 0) { if (i > 0) { vsllink_usb_out_buffer_idx++; } vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = 0; } if (path[i - start] == tap_transitions[cur_state].high) { vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] |= 1 << (i & 7); } else if (path[i - start] == tap_transitions[cur_state].low) { // nothing to do } else { LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", jtag_state_name(cur_state), jtag_state_name(path[i])); exit(-1); } cur_state = path[i - start]; } if ((i > 0) && ((i & 7) == 0)) { vsllink_usb_out_buffer_idx++; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = 0; } end_state = cur_state; } void vsllink_path_move(int num_states, enum tap_state *path) { int i, tms_len, tms_cmd_pos, path_idx = 0; if (vsllink_tms_data_len > 0) { // there are vsllink_tms_data_len more tms bits to be shifted // so there are vsllink_tms_data_len + num_states tms bits in all tms_len = vsllink_tms_data_len + num_states; if (tms_len <= 16) { // merge into last tms shift if (tms_len < 8) { // just append tms data to the last tms byte vsllink_add_path(vsllink_tms_data_len, num_states, path); } else if (tms_len == 8) { // end last tms shift command (*vsllink_tms_cmd_pos)--; vsllink_add_path(vsllink_tms_data_len, num_states, path); } else if (tms_len < 16) { if ((*vsllink_tms_cmd_pos & VSLLINK_CMDJTAGSEQ_LENMSK) < VSLLINK_CMDJTAGSEQ_LENMSK) { // every tms shift command can contain VSLLINK_CMDJTAGSEQ_LENMSK + 1 bytes in most // there is enought tms length in the current tms shift command (*vsllink_tms_cmd_pos)++; vsllink_add_path(vsllink_tms_data_len, num_states, path); } else { // every tms shift command can contain VSLLINK_CMDJTAGSEQ_LENMSK + 1 bytes in most // not enough tms length in the current tms shift command // so a new command should be added // first decrease byte length of last tms shift command (*vsllink_tms_cmd_pos)--; // append tms data to the last tms byte vsllink_add_path(vsllink_tms_data_len, 8 - vsllink_tms_data_len, path); path += 8 - vsllink_tms_data_len; // add new command(3 bytes) vsllink_tap_ensure_space(0, 3); vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx]; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | 1; vsllink_add_path(0, num_states - (8 - vsllink_tms_data_len), path); } } else if (tms_len == 16) { // end last tms shift command vsllink_add_path(vsllink_tms_data_len, num_states, path); } vsllink_tms_data_len = (vsllink_tms_data_len + num_states) & 7; if (vsllink_tms_data_len == 0) { vsllink_tms_cmd_pos = NULL; } num_states = 0; } else { vsllink_add_path(vsllink_tms_data_len, 16 - vsllink_tms_data_len, path); path += 16 - vsllink_tms_data_len; num_states -= 16 - vsllink_tms_data_len; vsllink_tms_data_len = 0; vsllink_tms_cmd_pos = NULL; } } if (num_states > 0) { // Normal operation, don't need to append tms data vsllink_tms_data_len = num_states & 7; while (num_states > 0) { if (num_states > ((VSLLINK_CMDJTAGSEQ_LENMSK + 1) * 8)) { i = (VSLLINK_CMDJTAGSEQ_LENMSK + 1) * 8; } else { i = num_states; } tms_len = (i + 7) >> 3; vsllink_tap_ensure_space(0, tms_len + 2); tms_cmd_pos = vsllink_usb_out_buffer_idx; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | (tms_len - 1); vsllink_add_path(0, i, path + path_idx); path_idx += i; num_states -= i; } if (vsllink_tms_data_len > 0) { if (tms_len < (VSLLINK_CMDJTAGSEQ_LENMSK + 1)) { vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[tms_cmd_pos]; (*vsllink_tms_cmd_pos)++; } else { vsllink_usb_out_buffer[tms_cmd_pos]--; tms_len = vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx]; vsllink_tap_ensure_space(0, 3); vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx]; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | 1; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = tms_len; } } } } void vsllink_runtest(int num_cycles) { int tms_len; enum tap_state saved_end_state = end_state; if (cur_state != TAP_IDLE) { // enter into IDLE state vsllink_end_state(TAP_IDLE); vsllink_state_move(); } else { // cur_state == TAP_IDLE if (vsllink_tms_data_len > 0) { // there are vsllink_tms_data_len more tms bits to be shifted // so there are vsllink_tms_data_len + num_cycles tms bits in all tms_len = vsllink_tms_data_len + num_cycles; if (tms_len <= 16) { // merge into last tms shift if (tms_len < 8) { // just add to vsllink_tms_data_len // same result if tun through //vsllink_tms_data_len += num_cycles; } else if (tms_len == 8) { // end last tms shift command // just reduce it, no need to append_tms (*vsllink_tms_cmd_pos)--; vsllink_usb_out_buffer_idx++; } else if (tms_len < 16) { if ((*vsllink_tms_cmd_pos & VSLLINK_CMDJTAGSEQ_LENMSK) < VSLLINK_CMDJTAGSEQ_LENMSK) { // every tms shift command can contain VSLLINK_CMDJTAGSEQ_LENMSK + 1 bytes in most // there is enought tms length in the current tms shift command // increase the tms byte length by 1 and set the last byte to 0 (*vsllink_tms_cmd_pos)++; vsllink_usb_out_buffer_idx++; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = 0; } else { // every tms shift command can contain VSLLINK_CMDJTAGSEQ_LENMSK + 1 bytes in most // not enough tms length in the current tms shift command // so a new command should be added // first decrease byte length of last tms shift command (*vsllink_tms_cmd_pos)--; // move the command pointer to the next empty position vsllink_usb_out_buffer_idx++; // add new command(3 bytes) vsllink_tap_ensure_space(0, 3); vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx]; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | 1; vsllink_usb_out_buffer[++vsllink_usb_out_buffer_idx] = 0; } } else if (tms_len == 16) { // end last tms shift command vsllink_usb_out_buffer_idx++; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0; } vsllink_tms_data_len = (vsllink_tms_data_len + num_cycles) & 7; if (vsllink_tms_data_len == 0) { vsllink_tms_cmd_pos = NULL; } num_cycles = 0; } else { vsllink_usb_out_buffer_idx++; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0; num_cycles -= 16 - vsllink_tms_data_len; vsllink_tms_data_len = 0; vsllink_tms_cmd_pos = NULL; } } } // from here vsllink_tms_data_len == 0 or num_cycles == 0 if (vsllink_tms_data_len > 0) { // num_cycles == 0 // no need to shift if (num_cycles > 0) { LOG_ERROR("There MUST be some bugs in the driver"); exit(-1); } } else { // get number of bytes left to be sent tms_len = num_cycles >> 3; if (tms_len > 0) { vsllink_tap_ensure_space(1, 5); // if tms_len > 0, vsllink_tms_data_len == 0 // so just add new command vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMS0BYTE; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms_len >> 0) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms_len >> 8) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms_len >> 16) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tms_len >> 24) & 0xff; vsllink_usb_in_want_length += 1; pending_scan_results_buffer[pending_scan_results_length].buffer = NULL; pending_scan_results_length++; if (tms_len > 0xFFFF) { vsllink_tap_execute(); vsllink_usb_out_buffer[0] = VSLLINK_CMD_HW_JTAGSEQCMD; vsllink_usb_out_buffer_idx = 3; } } vsllink_tms_data_len = num_cycles & 7; if (vsllink_tms_data_len > 0) { vsllink_tap_ensure_space(0, 3); vsllink_tms_cmd_pos = &vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx]; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_TMSBYTE | 1; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] = 0; } } // post-process // set end_state vsllink_end_state(saved_end_state); cur_state = TAP_IDLE; if (end_state != TAP_IDLE) { vsllink_state_move(); } } void vsllink_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command) { enum tap_state saved_end_state; u8 bits_left, tms_tmp, tdi_len; int i; if (0 == scan_size ) { return; } tdi_len = ((scan_size + 7) >> 3); if ((tdi_len + 7) > VSLLINK_BufferSize) { LOG_ERROR("Your implementation of VSLLink has not enough buffer"); exit(-1); } saved_end_state = end_state; /* Move to appropriate scan state */ vsllink_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT); if (vsllink_tms_data_len > 0) { if (cur_state == end_state) { // already in IRSHIFT or DRSHIFT state // merge tms data in the last tms shift command into next scan command if(*vsllink_tms_cmd_pos < 1) { LOG_ERROR("There MUST be some bugs in the driver"); exit(-1); } else if(*vsllink_tms_cmd_pos < 2) { tms_tmp = vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx]; vsllink_usb_out_buffer_idx--; } else { tms_tmp = vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx]; *vsllink_tms_cmd_pos -= 2; } vsllink_tap_ensure_space(1, tdi_len + 7); // VSLLINK_CMDJTAGSEQ_SCAN ored by 1 means that tms_before is valid // which is merged from the last tms shift command vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_SCAN | 1; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = ((tdi_len + 1) >> 0) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = ((tdi_len + 1)>> 8) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = tms_tmp; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = buffer[0] << (8 - vsllink_tms_data_len); for (i = 0; i < tdi_len; i++) { buffer[i] >>= 8 - vsllink_tms_data_len; if (i != tdi_len) { buffer[i] += buffer[i + 1] << vsllink_tms_data_len; } } vsllink_tap_append_scan(scan_size - vsllink_tms_data_len, buffer, command, vsllink_tms_data_len); scan_size -= 8 - vsllink_tms_data_len; vsllink_tms_data_len = 0; } else { vsllink_append_tms(); vsllink_tap_ensure_space(1, tdi_len + 5); vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_SCAN; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tdi_len >> 0) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = (tdi_len >> 8) & 0xff; vsllink_tap_append_scan(scan_size, buffer, command, 0); } } else { vsllink_tap_ensure_space(1, tdi_len + 7); vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_CMDJTAGSEQ_SCAN | 1; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = ((tdi_len + 1) >> 0) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = ((tdi_len + 1)>> 8) & 0xff; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_TAP_MOVE(cur_state, end_state); vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0; vsllink_tap_append_scan(scan_size, buffer, command, 8); } vsllink_end_state(saved_end_state); bits_left = scan_size & 0x07; cur_state = ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE; if (bits_left > 0) { vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 1 << (bits_left - 1); } else { vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 1 << 7; } if (cur_state != end_state) { vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = VSLLINK_TAP_MOVE(cur_state, end_state); } else { vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0; } cur_state = end_state; } void vsllink_reset(int trst, int srst) { int result; LOG_DEBUG("trst: %i, srst: %i", trst, srst); /* Signals are active low */ vsllink_usb_out_buffer[0] = VSLLINK_CMD_SET_PORT; vsllink_usb_out_buffer[1] = JTAG_PINMSK_SRST | JTAG_PINMSK_TRST; vsllink_usb_out_buffer[2] = 0; if (srst == 0) { vsllink_usb_out_buffer[2] |= JTAG_PINMSK_SRST; } if (trst == 0) { vsllink_usb_out_buffer[2] |= JTAG_PINMSK_TRST; } result = vsllink_usb_write(vsllink_jtag_handle, 3); if (result != 3) { LOG_ERROR("VSLLink command VSLLINK_CMD_SET_PORT failed (%d)", result); } } void vsllink_simple_command(u8 command) { int result; DEBUG_JTAG_IO("0x%02x", command); vsllink_usb_out_buffer[0] = command; result = vsllink_usb_write(vsllink_jtag_handle, 1); if (result != 1) { LOG_ERROR("VSLLink command 0x%02x failed (%d)", command, result); } } int vsllink_handle_usb_vid_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { if (argc != 1) { LOG_ERROR("parameter error, should be one parameter for VID"); return ERROR_OK; } vsllink_vid = strtol(args[0], NULL, 0); return ERROR_OK; } int vsllink_handle_usb_pid_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { if (argc != 1) { LOG_ERROR("parameter error, should be one parameter for PID"); return ERROR_OK; } vsllink_pid = strtol(args[0], NULL, 0); return ERROR_OK; } int vsllink_handle_usb_bulkin_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { if (argc != 1) { LOG_ERROR("parameter error, should be one parameter for BULKIN endpoint"); return ERROR_OK; } vsllink_bulkin = strtol(args[0], NULL, 0) | 0x80; return ERROR_OK; } int vsllink_handle_usb_bulkout_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { if (argc != 1) { LOG_ERROR("parameter error, should be one parameter for BULKOUT endpoint"); return ERROR_OK; } vsllink_bulkout = strtol(args[0], NULL, 0); return ERROR_OK; } /***************************************************************************/ /* VSLLink tap functions */ void vsllink_tap_init(void) { vsllink_usb_out_buffer_idx = 0; vsllink_usb_in_want_length = 0; pending_scan_results_length = 0; } void vsllink_tap_ensure_space(int scans, int bytes) { int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length; int available_bytes = VSLLINK_BufferSize - vsllink_usb_out_buffer_idx; if (scans > available_scans || bytes > available_bytes) { vsllink_tap_execute(); vsllink_usb_out_buffer[0] = VSLLINK_CMD_HW_JTAGSEQCMD; vsllink_usb_out_buffer_idx = 3; } } void vsllink_tap_append_scan(int length, u8 *buffer, scan_command_t *command, int offset) { pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length]; int i; if (offset > 0) { vsllink_usb_in_want_length += ((length + 7) >> 3) + 1; } else { vsllink_usb_in_want_length += (length + 7) >> 3; } pending_scan_result->length = length; pending_scan_result->offset = offset; pending_scan_result->command = command; pending_scan_result->buffer = buffer; for (i = 0; i < ((length + 7) >> 3); i++) { vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = buffer[i]; } pending_scan_results_length++; } /* Pad and send a tap sequence to the device, and receive the answer. * For the purpose of padding we assume that we are in reset or idle or pause state. */ int vsllink_tap_execute(void) { int i; int result; int first = 0; if (vsllink_tms_data_len > 0) { if((cur_state != TAP_RESET) && (cur_state != TAP_IDLE) && (cur_state != TAP_IRPAUSE) && (cur_state != TAP_DRPAUSE)) { LOG_WARNING("%s is not in RESET or IDLE or PAUSR state", jtag_state_name(cur_state)); } if (vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx] & (1 << (vsllink_tms_data_len - 1))) { // last tms bit is '1' vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] |= 0xFF << vsllink_tms_data_len; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0xFF; vsllink_tms_data_len = 0; } else { // last tms bit is '0' vsllink_usb_out_buffer_idx++; vsllink_usb_out_buffer[vsllink_usb_out_buffer_idx++] = 0; vsllink_tms_data_len = 0; } } if (vsllink_usb_out_buffer_idx > 3) { if (vsllink_usb_out_buffer[0] == VSLLINK_CMD_HW_JTAGSEQCMD) { vsllink_usb_out_buffer[1] = (vsllink_usb_out_buffer_idx >> 0) & 0xff; vsllink_usb_out_buffer[2] = (vsllink_usb_out_buffer_idx >> 8) & 0xff; } result = vsllink_usb_message(vsllink_jtag_handle, vsllink_usb_out_buffer_idx, vsllink_usb_in_want_length); if (result == vsllink_usb_in_want_length) { for (i = 0; i < pending_scan_results_length; i++) { pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[i]; u8 *buffer = pending_scan_result->buffer; int length = pending_scan_result->length; int offset = pending_scan_result->offset; scan_command_t *command = pending_scan_result->command; if (buffer != NULL) { // IRSHIFT or DRSHIFT buf_set_buf(vsllink_usb_in_buffer, first * 8 + offset, buffer, 0, length); first += (length + offset + 7) >> 3; DEBUG_JTAG_IO("JTAG scan read(%d bits):", length); #ifdef _DEBUG_JTAG_IO_ vsllink_debug_buffer(buffer, (length + 7) >> 3); #endif if (jtag_read_buffer(buffer, command) != ERROR_OK) { vsllink_tap_init(); return ERROR_JTAG_QUEUE_FAILED; } free(pending_scan_result->buffer); pending_scan_result->buffer = NULL; } else { first++; } } } else { LOG_ERROR("vsllink_tap_execute, wrong result %d, expected %d", result, vsllink_usb_in_want_length); return ERROR_JTAG_QUEUE_FAILED; } vsllink_tap_init(); } return ERROR_OK; } /*****************************************************************************/ /* VSLLink USB low-level functions */ vsllink_jtag_t* vsllink_usb_open(void) { struct usb_bus *busses; struct usb_bus *bus; struct usb_device *dev; vsllink_jtag_t *result; result = (vsllink_jtag_t*) malloc(sizeof(vsllink_jtag_t)); usb_init(); usb_find_busses(); usb_find_devices(); busses = usb_get_busses(); /* find vsllink_jtag device in usb bus */ for (bus = busses; bus; bus = bus->next) { for (dev = bus->devices; dev; dev = dev->next) { if ((dev->descriptor.idVendor == vsllink_vid) && (dev->descriptor.idProduct == vsllink_pid)) { result->usb_handle = usb_open(dev); /* usb_set_configuration required under win32 */ usb_set_configuration(result->usb_handle, dev->config[0].bConfigurationValue); usb_claim_interface(result->usb_handle, 0); #if 0 /* * This makes problems under Mac OS X. And is not needed * under Windows. Hopefully this will not break a linux build */ usb_set_altinterface(result->usb_handle, 0); #endif return result; } } } free(result); return NULL; } void vsllink_usb_close(vsllink_jtag_t *vsllink_jtag) { usb_close(vsllink_jtag->usb_handle); free(vsllink_jtag); } /* Send a message and receive the reply. */ int vsllink_usb_message(vsllink_jtag_t *vsllink_jtag, int out_length, int in_length) { int result; result = vsllink_usb_write(vsllink_jtag, out_length); if (result == out_length) { if (in_length > 0) { result = vsllink_usb_read(vsllink_jtag); if (result == in_length ) { return result; } else { LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)", in_length, result); return -1; } } return 0; } else { LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)", out_length, result); return -1; } } /* Write data from out_buffer to USB. */ int vsllink_usb_write(vsllink_jtag_t *vsllink_jtag, int out_length) { int result; if (out_length > VSLLINK_BufferSize) { LOG_ERROR("vsllink_jtag_write illegal out_length=%d (max=%d)", out_length, VSLLINK_BufferSize); return -1; } result = usb_bulk_write(vsllink_jtag->usb_handle, vsllink_bulkout, \ (char *)vsllink_usb_out_buffer, out_length, VSLLINK_USB_TIMEOUT); DEBUG_JTAG_IO("vsllink_usb_write, out_length = %d, result = %d", out_length, result); #ifdef _DEBUG_USB_COMMS_ LOG_DEBUG("USB out:"); vsllink_debug_buffer(vsllink_usb_out_buffer, out_length); #endif #ifdef _VSLLINK_IN_DEBUG_MODE_ usleep(100000); #endif return result; } /* Read data from USB into in_buffer. */ int vsllink_usb_read(vsllink_jtag_t *vsllink_jtag) { int result = usb_bulk_read(vsllink_jtag->usb_handle, vsllink_bulkin, \ (char *)vsllink_usb_in_buffer, VSLLINK_BufferSize, VSLLINK_USB_TIMEOUT); DEBUG_JTAG_IO("vsllink_usb_read, result = %d", result); #ifdef _DEBUG_USB_COMMS_ LOG_DEBUG("USB in:"); vsllink_debug_buffer(vsllink_usb_in_buffer, result); #endif return result; } #define BYTES_PER_LINE 16 void vsllink_debug_buffer(u8 *buffer, int length) { char line[81]; char s[4]; int i; int j; for (i = 0; i < length; i += BYTES_PER_LINE) { snprintf(line, 5, "%04x", i); for (j = i; j < i + BYTES_PER_LINE && j < length; j++) { snprintf(s, 4, " %02x", buffer[j]); strcat(line, s); } LOG_DEBUG(line); } }