URL https://opencores.org/ocsvn/or1k_soc_on_altera_embedded_dev_kit/or1k_soc_on_altera_embedded_dev_kit/trunk
Subversion Repositories or1k_soc_on_altera_embedded_dev_kit

[/] [or1k_soc_on_altera_embedded_dev_kit/] [trunk/] [soc/] [sw/] [adv_jtag_bridge/] [cable_usbblaster.c] - Blame information for rev 12

Go to most recent revision | Details | Compare with Previous | View Log

/* cable_usbblaster.c - Altera USB Blaster driver for the Advanced JTAG Bridge
   Copyright (C) 2008 Nathan Yawn, nathan.yawn@opencores.org
 
   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., 675 Mass Ave, Cambridge, MA 02139, USA. */
 
 
#include <stdio.h>
#include <sys/types.h>
#include <unistd.h>  // for usleep()
#include <stdlib.h>  // for sleep()
#include <arpa/inet.h> // for htons()
#include <sys/time.h>
#include <time.h>
 
#ifdef __SUPPORT_FTDI_CABLES__
#include <ftdi.h>
#endif
 
#include "usb.h"  // libusb header
#include "cable_common.h"
#include "errcodes.h"
 
#define debug(...) //fprintf(stderr, __VA_ARGS__ )
 
// USB constants for the USB Blaster
// Valid endpoints: 0x81, 0x02, 0x06, 0x88
#define EP2        0x02
#define EP1        0x81
#define ALTERA_VID 0x09FB
#define ALTERA_PID 0x6001
 
//#define USB_TIMEOUT 500
#define USB_TIMEOUT 10000
 
 
// Bit meanings in the command byte sent to the USB-Blaster
#define USBBLASTER_CMD_TCK 0x01
#define USBBLASTER_CMD_TMS 0x02
#define USBBLASTER_CMD_nCE 0x04  /* should be left low */
#define USBBLASTER_CMD_nCS 0x08  /* must be set for byte-shift mode reads to work */
#define USBBLASTER_CMD_TDI 0x10
#define USBBLASTER_CMD_OE  0x20  /* appears necessary to set it to make everything work */
#define USBBLASTER_CMD_READ 0x40
#define USBBLASTER_CMD_BYTESHIFT 0x80
 
 
static struct usb_device *usbblaster_device;
 
static char *data_out_scratchpad = NULL;
static int data_out_scratchpad_size = 0;
static char *data_in_scratchpad = NULL;
static int data_in_scratchpad_size = 0;
 
#ifdef __SUPPORT_FTDI_CABLES__
static struct ftdi_context ftdic;
#endif
 
 
///////////////////////////////////////////////////////////////////////////////
/*-------------------------------------[ USB Blaster specific functions ]---*/
/////////////////////////////////////////////////////////////////////////////
 
 
static int usbblaster_start_interface(struct usb_dev_handle *xpcu)
{
  // Need to send a VENDOR request OUT, request = GET_STATUS
  // Other parameters are ignored
  if(usb_control_msg(xpcu, (USB_ENDPOINT_OUT | USB_TYPE_VENDOR), USB_REQ_GET_STATUS,
                     0, 0, NULL, 0, 1000)<0)
    {
      perror("usb_control_msg(start interface)");
      return APP_ERR_USB;
    }
 
  return APP_ERR_NONE;
}
 
 
static int usbblaster_read_firmware_version(struct usb_dev_handle *xpcu, uint16_t *buf)
{
  if(usb_control_msg(xpcu, 0xC0, 0x90, 0, 3, (char*)buf, 2, USB_TIMEOUT)<0)
    {
      perror("usb_control_msg(0x90.0) (read_firmware_version)");
      return APP_ERR_USB;
    }
 
  // Swap endian
  *buf = htons(*buf);
  //*buf = (*buf << 8) | (*buf >> 8);
 
  return APP_ERR_NONE;
}
 
 
 
static int usbblaster_enumerate_bus(void)
{
  int             flag;  // for USB bus scanning stop condition
  struct usb_bus *bus;   // pointer on the USB bus
 
  // board detection
  usb_init();
  usb_find_busses();
  usb_find_devices();
 
  flag = 0;
 
  for (bus = usb_get_busses(); bus; bus = bus->next)
  {
    for (usbblaster_device = bus->devices; usbblaster_device; usbblaster_device = usbblaster_device->next)
    {
      if (usbblaster_device->descriptor.idVendor  == ALTERA_VID &&
          usbblaster_device->descriptor.idProduct == ALTERA_PID)
      {
              flag = 1;
              fprintf(stderr, "Found Altera USB-Blaster\n");
              return APP_ERR_NONE;
      }
    }
    if (flag)
      break;
  }
 
  fprintf(stderr, "Failed to find USB-Blaster\n");
  return APP_ERR_CABLENOTFOUND;
}
 
 
int cable_usbblaster_init(){
  int err = APP_ERR_NONE;
 
  // Process to reset the usb blaster
  if(err |= usbblaster_enumerate_bus()) {
    return err;
  }
 
  usb_dev_handle *h_device = usb_open(usbblaster_device);
 
  if(h_device == NULL)
    {
      fprintf(stderr, "Init failed to open USB device for reset\n");
      return APP_ERR_USB;
    }
 
  if(usb_reset(h_device) != APP_ERR_NONE)
    fprintf(stderr, "Failed to reset USB Blaster\n");
 
  usb_close(h_device);
 
  // Wait for reset!!!
  sleep(1);
 
  // Do device initialization
  if(err |= usbblaster_enumerate_bus())
    return err;
 
  h_device = usb_open(usbblaster_device);
  if(h_device == NULL)
    {
      fprintf(stderr, "Init failed to open USB device for initialization\n");
      return APP_ERR_USB;
    }
 
  // set the configuration
  if (usb_set_configuration(h_device, usbblaster_device->config->bConfigurationValue))
    {
      usb_close(h_device);
      fprintf(stderr, "USB-reset failed to set configuration\n");
      return APP_ERR_NONE;
    }
 
  while (usb_claim_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber));
 
  //usb_clear_halt(h_device, EP1);
  //usb_clear_halt(h_device, EP2);
 
  // IMPORTANT:  DO NOT SEND A REQUEST TYPE "CLASS" OR TYPE "RESERVED".  This may stall the EP.
 
  // Some clones need this before they will start processing IN/OUT requests
  if(usbblaster_start_interface(h_device) != APP_ERR_NONE)
    fprintf(stderr, "Failed to start remote interface\n");
 
  uint16_t buf;
  if(err |= usbblaster_read_firmware_version(h_device, &buf))
    {
      usb_close(h_device);
      fprintf(stderr, "Failed to read firmware version\n");
      return err;
    }
  else
    {
      printf("firmware version = 0x%04X (%u)\n", buf, buf);
    }
 
 
  // USB blaster is expecting us to read 2 bytes, which are useless to us...
  char ret[2];
  int rv = usb_bulk_read(h_device, EP1, ret, 2, USB_TIMEOUT);
  if (rv < 0){  // But if we fail, who cares?
    fprintf(stderr, "\nWarning: Failed to read post-init bytes from the EP1 FIFO (%i):\n%s", rv, usb_strerror());
  }
 
  if (usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber)){
    usb_close(h_device);
    fprintf(stderr, "USB-out failed to release interface\n");
    return APP_ERR_USB;
  }
 
  usb_close(h_device);
 
  data_out_scratchpad = (char *) malloc(64);
  data_out_scratchpad_size = 64;
  data_in_scratchpad = (char *) malloc(64);
  data_in_scratchpad_size = 64;
 
  return APP_ERR_NONE;
}
 
 
int cable_usbblaster_out(uint8_t value)
{
  int             rv;                  // to catch return values of functions
  usb_dev_handle *h_device;            // handle on the ubs device
  char out;
  int err = APP_ERR_NONE;
 
  // open the device
  h_device = usb_open(usbblaster_device);
  if (h_device == NULL){
    usb_close(h_device);
    fprintf(stderr, "USB-out failed to open device\n");
    return APP_ERR_USB;
  }
 
  // set the configuration
  if (usb_set_configuration(h_device, usbblaster_device->config->bConfigurationValue))
    {
      usb_close(h_device);
      fprintf(stderr, "USB-out failed to set configuration\n");
      return APP_ERR_USB;
    }
 
  // wait until device is ready
  while (usb_claim_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber));
 
  out = (USBBLASTER_CMD_OE | USBBLASTER_CMD_nCS);  // Set output enable (appears necessary) and nCS (necessary for byte-shift reads)
 
  // Translate to USB blaster protocol
  // USB-Blaster has no TRST pin
  if(value & TCLK_BIT)
    out |= USBBLASTER_CMD_TCK;
  if(value & TDI_BIT)
    out |= USBBLASTER_CMD_TDI;
  if(value & TMS_BIT)
    out |= USBBLASTER_CMD_TMS;
 
 
  rv = usb_bulk_write(h_device, EP2, &out, 1, USB_TIMEOUT);
  if (rv != 1){
    fprintf(stderr, "\nFailed to write to the FIFO (rv = %d):\n%s", rv, usb_strerror());
    err |= APP_ERR_USB;
  }
 
  // release the interface cleanly
  if (usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber)){
    fprintf(stderr, "Warning: failed to release usb interface after write\n");
    err |= APP_ERR_USB;
  }
 
  // close the device
  usb_close(h_device);
  return err;
}
 
 
int cable_usbblaster_inout(uint8_t value, uint8_t *in_bit)
{
  int             rv;                  // to catch return values of functions
  usb_dev_handle *h_device;            // handle on the usb device
  char ret[3] = {0,0,0};               // Two useless bytes (0x31,0x60) always precede the useful byte
  char out;
 
  out = (USBBLASTER_CMD_OE | USBBLASTER_CMD_nCS);  // Set output enable (?) and nCS (necessary for byte-shift reads)
  out |=  USBBLASTER_CMD_READ;
 
  // Translate to USB blaster protocol
  // USB-Blaster has no TRST pin
  if(value & TCLK_BIT)
    out |= USBBLASTER_CMD_TCK;
  if(value & TDI_BIT)
    out |= USBBLASTER_CMD_TDI;
  if(value & TMS_BIT)
    out |= USBBLASTER_CMD_TMS;
 
 
  // open the device
  h_device = usb_open(usbblaster_device);
  if (h_device == NULL){
    return APP_ERR_USB;
  }
 
  // set the configuration
  if (usb_set_configuration(h_device, usbblaster_device->config->bConfigurationValue)){
    usb_close(h_device);
    return APP_ERR_USB;
  }
 
  // wait until device is ready
  while (usb_claim_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber));
 
  // Send a read request
  rv = usb_bulk_write(h_device, EP2, &out, 1, USB_TIMEOUT);
  if (rv != 1){
    fprintf(stderr, "\nFailed to write a read request to the EP2 FIFO:\n%s", usb_strerror());
    usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber);
    usb_close(h_device);
    return APP_ERR_USB;
  }
 
 
  // receive the response
  // Sometimes, we do a read but just get the useless 0x31,0x60 chars...
  // retry until we get a 3rd byte (with real data), for a reasonable number of retries.
  int retries = 0;
  do {
    rv = usb_bulk_read(h_device, EP1, ret, 3, USB_TIMEOUT);
    if (rv < 0){
      fprintf(stderr, "\nFailed to read from the EP1 FIFO (%i):\n%s", rv, usb_strerror());
      usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber);
      usb_close(h_device);
      return APP_ERR_USB;
    }
 
    // fprintf(stderr, "Read %i bytes: 0x%X, 0x%X, 0x%X\n", rv, ret[0], ret[1], ret[2]);
    retries++;
  }
  while((rv < 3) && (retries < 20));
 
 
  // release the interface cleanly
  if (usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber)){
    fprintf(stderr, "Warning: failed to release USB interface after read\n");
    usb_close(h_device);
    return APP_ERR_USB;
  }
 
  // close the device
  usb_close(h_device);
 
  *in_bit = (ret[2] & 0x01); /* TDO is bit 0.  USB-Blaster may also set bit 1. */
  return APP_ERR_NONE;
}
 
 
// The usbblaster transfers the bits in the stream in the following order:
// bit 0 of the first byte received ... bit 7 of the first byte received
// bit 0 of second byte received ... etc.
int cable_usbblaster_write_stream(uint32_t *stream, int len_bits, int set_last_bit) {
  int             rv;                  // to catch return values of functions
  usb_dev_handle *h_device;            // handle on the ubs device
  unsigned int bytes_to_transfer, leftover_bit_length;
  uint32_t leftover_bits;
  unsigned char i;
  int err = APP_ERR_NONE;
 
  //printf("cable_usbblaster_write_stream(0x%X, %d, %i)\n", stream, len, set_last_bit);
 
  // This routine must transfer at least 8 bits.  Additionally, TMS (the last bit)
  // cannot be set by 'byte shift mode'.  So we need at least 8 bits to transfer,
  // plus one bit to send along with TMS.
  bytes_to_transfer = len_bits / 8;
  leftover_bit_length = len_bits - (bytes_to_transfer * 8);
 
  if((!leftover_bit_length) && set_last_bit) {
    bytes_to_transfer -= 1;
    leftover_bit_length += 8;
  }
 
  //printf("bytes_to_transfer: %d. leftover_bit_length: %d\n", bytes_to_transfer, leftover_bit_length);
 
  // Not enough bits for high-speed transfer. bit-bang.
  if(bytes_to_transfer == 0) {
    return cable_common_write_stream(stream, len_bits, set_last_bit);
  }
 
  // Bitbang functions leave clock high.  USBBlaster assumes clock low at the start of a burst.
  // Lower the clock.
  err |= cable_usbblaster_out(0);
 
  // Set leftover bits
  leftover_bits = (stream[bytes_to_transfer>>2] >> ((bytes_to_transfer & 0x3) * 8)) & 0xFF;
 
  //printf("leftover_bits: 0x%X, LSB_first_xfer = %d\n", leftover_bits, LSB_first_xfer);
 
  // open the device
  h_device = usb_open(usbblaster_device);
  if (h_device == NULL){
    usb_close(h_device);
    fprintf(stderr, "USBBlaster_write_stream failed to open device\n");
    return APP_ERR_USB;
  }
 
  // set the configuration
  if (usb_set_configuration(h_device, usbblaster_device->config->bConfigurationValue))
  {
    usb_close(h_device);
    fprintf(stderr, "USBBlaster_write_stream failed to set configuration\n");
    return APP_ERR_USB;
  }
 
  // wait until device is ready
  while (usb_claim_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber));
 
 
  // Copy stream into out.  Not pretty, but better than changing the interface to the upper layers;
  // 32 bits are easier to work with than 8 bits in upper layers.
  if(data_out_scratchpad_size < (bytes_to_transfer+1)) {
    free(data_out_scratchpad);
    data_out_scratchpad = (char *) malloc(bytes_to_transfer+1);  // free/malloc instead of realloc will save copy time
    if(data_out_scratchpad == NULL) {
      usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber);
      usb_close(h_device);
      return APP_ERR_MALLOC;
    }
    data_out_scratchpad_size = bytes_to_transfer+1;
  }
 
  data_out_scratchpad[0] = USBBLASTER_CMD_BYTESHIFT | (bytes_to_transfer & 0x3F);
  for(i = 0; i < bytes_to_transfer; i++) {
    data_out_scratchpad[i+1] = (stream[i>>2] >> (8*(i&0x3))) & 0xFF;
  }
 
 
  /*
    printf("Data packet: ");
    for(i = 0; i <= bytes_to_transfer; i++)
    printf("0x%X ", out[i]);
    printf("\n");
  */
 
  rv = usb_bulk_write(h_device, EP2, data_out_scratchpad, bytes_to_transfer+1, USB_TIMEOUT);
  if (rv != (bytes_to_transfer+1)){
    fprintf(stderr, "\nFailed to write to the FIFO (rv = %d):\n%s", rv, usb_strerror());
    err |= APP_ERR_USB;
  }
 
  // release the interface cleanly
  if (usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber)){
        fprintf(stderr, "Warning: failed to release usb interface after stream write\n");
  }
 
  // close the device
  usb_close(h_device);
 
  // if we have a number of bits not divisible by 8, or we need to set TMS...
  if(leftover_bit_length != 0) {
    //printf("Doing leftovers: (0x%X, %d, %d)\n", leftover_bits, leftover_bit_length, set_last_bit);
    return cable_common_write_stream(&leftover_bits, leftover_bit_length, set_last_bit);
  }
 
  return err;
}
 
 
int cable_usbblaster_read_stream(uint32_t *outstream, uint32_t *instream, int len_bits, int set_last_bit) {
  int             rv;                  // to catch return values of functions
  usb_dev_handle *h_device;            // handle on the ubs device
  unsigned int bytes_received = 0;
  unsigned int bytes_to_transfer, leftover_bit_length;
  uint32_t leftover_bits, leftovers_received = 0;
  unsigned char i;
  int retval = APP_ERR_NONE;
 
  debug("cable_usbblaster_read_stream(0x%X, %d, %i)\n", outstream[0], len_bits, set_last_bit);
 
  // This routine must transfer at least 8 bits.  Additionally, TMS (the last bit)
  // cannot be set by 'byte shift mode'.  So we need at least 8 bits to transfer,
  // plus one bit to send along with TMS.
  bytes_to_transfer = len_bits / 8;
  leftover_bit_length = len_bits - (bytes_to_transfer * 8);
 
  if((!leftover_bit_length) && set_last_bit) {
    bytes_to_transfer -= 1;
    leftover_bit_length += 8;
  }
 
  //printf("RD bytes_to_transfer: %d. leftover_bit_length: %d\n", bytes_to_transfer, leftover_bit_length);
 
  // Not enough bits for high-speed transfer. bit-bang.
  if(bytes_to_transfer == 0) {
    return cable_common_read_stream(outstream, instream, len_bits, set_last_bit);
    //retval |= cable_common_read_stream(&leftover_bits, &leftovers_received, leftover_bit_length, set_last_bit);
  }
 
  // Bitbang functions leave clock high.  USBBlaster assumes clock low at the start of a burst.
  // Lower the clock.
  retval |= cable_usbblaster_out(0);
 
  // Zero the input, since we add new data by logical-OR
  for(i = 0; i < (len_bits/32); i++)
    instream[i] = 0;
  if(len_bits % 32)
    instream[i] = 0;
 
  // Set leftover bits
  leftover_bits = (outstream[bytes_to_transfer>>2] >> ((bytes_to_transfer & 0x3) * 8)) & 0xFF;
  debug("leftover_bits: 0x%X\n", leftover_bits);
 
  // open the device
  h_device = usb_open(usbblaster_device);
  if (h_device == NULL){
        usb_close(h_device);
        fprintf(stderr, "USBBlaster_read_stream failed to open device\n");
        return APP_ERR_USB;
  }
 
  // set the configuration
  if (usb_set_configuration(h_device, usbblaster_device->config->bConfigurationValue))
  {
        usb_close(h_device);
        fprintf(stderr, "USBBlaster_read_stream failed to set configuration\n");
        return APP_ERR_USB;
  }
 
  // wait until device is ready
  while (usb_claim_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber));
 
 
 
  // Copy stream into out.  Not pretty, but better than changing the interface to the upper layers;
  // 32 bits are easier to work with than 8 bits in upper layers.
  if(data_out_scratchpad_size < (bytes_to_transfer+1)) {
    free(data_out_scratchpad);
    data_out_scratchpad = (char *) malloc(bytes_to_transfer+1);  // free/malloc instead of realloc will save copy time
    if(data_out_scratchpad == NULL) {
      usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber);
      usb_close(h_device);
      return APP_ERR_MALLOC;
    }
    data_out_scratchpad_size = bytes_to_transfer+1;
  }
 
  data_out_scratchpad[0] = USBBLASTER_CMD_BYTESHIFT | USBBLASTER_CMD_READ | (bytes_to_transfer & 0x3F);  // Set command byte
  for(i = 0; i < bytes_to_transfer; i++) {
    data_out_scratchpad[i+1] = (outstream[i>>2] >> (8*(i&0x3))) & 0xFF;
  }
 
  /*
  debug("Data packet: ");
  for(i = 0; i <= bytes_to_transfer; i++)
    debug("0x%X ", data_out_scratchpad[i]);
  debug("\n");
  */
 
  rv = usb_bulk_write(h_device, EP2, data_out_scratchpad, bytes_to_transfer+1, USB_TIMEOUT);
  if (rv != (bytes_to_transfer+1)){
    fprintf(stderr, "\nFailed to write to the EP2 FIFO (rv = %d):\n%s", rv, usb_strerror());
    usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber);
    usb_close(h_device);
    return APP_ERR_USB;
  }
 
 
  // Make sure we have a big-enough buffer to hold the incoming data
  if(data_in_scratchpad_size < (bytes_to_transfer+2)) {
    free(data_in_scratchpad);
    data_in_scratchpad = (char *) malloc(bytes_to_transfer+2);  // free/malloc instead of realloc will save copy time
    if(data_in_scratchpad == NULL) {
      usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber);
      usb_close(h_device);
      return APP_ERR_MALLOC;
    }
    data_in_scratchpad_size = (bytes_to_transfer+2);
  }
 
  // receive the response
  // Sometimes, we do a read but just get the useless 0x31,0x60 chars...
  // retry until we get at least 3 bytes (with real data), for a reasonable number of retries.
  int retries = 0;
  bytes_received = 0;
  do {
    rv = usb_bulk_read(h_device, EP1, data_in_scratchpad, (bytes_to_transfer-bytes_received)+2, USB_TIMEOUT);
    if (rv < 0){
      fprintf(stderr, "\nFailed to read stream from the EP1 FIFO (%i):\n%s", rv, usb_strerror());
      usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber);
      usb_close(h_device);
      return APP_ERR_USB;
    }
 
    /*
    debug("Read %i bytes: ", rv);
    for(i = 0; i < rv; i++)
      debug("0x%X ", data_in_scratchpad[i]);
    debug("\n");
    */
 
    if(rv > 2) retries = 0;
    else retries++;
 
    /* Put the received bytes into the return stream.  */
    for(i = 0; i < (rv-2); i++) {
      // Do size/type promotion before shift.  Must cast to unsigned, else the value may be
      // sign-extended through the upper 16 bits of the uint32_t.
      uint32_t tmp = (unsigned char) data_in_scratchpad[2+i];
      instream[(bytes_received+i)>>2] |= (tmp << ((i & 0x3)*8));
    }
 
    bytes_received += (rv-2);
  }
  while((bytes_received < bytes_to_transfer) && (retries < 15));
 
 
  // release the interface cleanly
  if (usb_release_interface(h_device, usbblaster_device->config->interface->altsetting->bInterfaceNumber)){
        fprintf(stderr, "Warning: failed to release usb interface after stream read\n");
  }
 
  // close the device
  usb_close(h_device);
 
  // if we have a number of bits not divisible by 8
  if(leftover_bit_length != 0) {
    debug("Doing leftovers: (0x%X, %d, %d)\n", leftover_bits, leftover_bit_length, set_last_bit);
    retval |= cable_common_read_stream(&leftover_bits, &leftovers_received, leftover_bit_length, set_last_bit);
    instream[bytes_to_transfer>>2] |= (leftovers_received & 0xFF) << (8*(bytes_to_transfer & 0x3));
  }
 
  return retval;
}
 
 
int cable_usbblaster_opt(int c, char *str)
{
  fprintf(stderr, "Unknown parameter '%c'\n", c);
  return APP_ERR_BAD_PARAM;
}
 
 
//
// libusb does not work with my 3C25, but it works with libfdti.
// Following code is ported from http://www.ixo.de/info/usb_jtag/
// ZXF, 2009-10-22
//
#ifdef __SUPPORT_FTDI_CABLES__
 
int usb_blaster_buf_write(uint8_t *buf, int size, uint32_t* bytes_written)
{
        int retval;
 
        debug("usb_blaster_buf_write %02X (%d)\n", buf[0], size);
 
        if ((retval = ftdi_write_data(&ftdic, buf, size)) < 0) {
                *bytes_written = 0;
                printf("ftdi_write_data: %s\n", ftdi_get_error_string(&ftdic));
                return -1;
        } else {
                *bytes_written = retval;
                return 0;
        }
}
 
int usb_blaster_buf_read(uint8_t* buf, int size, uint32_t* bytes_read)
{
        int retval;
        int timeout = 100;
        *bytes_read = 0;
 
        while ((*bytes_read < size) && timeout--) {
                if ((retval = ftdi_read_data(&ftdic, buf + *bytes_read, size - *bytes_read)) < 0) {
                        *bytes_read = 0;
                        printf("ftdi_read_data: %s\n", ftdi_get_error_string(&ftdic));
                        return -1;
                }
                *bytes_read += retval;
        }
 
        debug("usb_blaster_buf_read %02X (%d)\n", buf[0], *bytes_read);
 
        return 0;
}
 
/* The following code doesn't fully utilize the possibilities of the USB-Blaster. It
 * writes one byte per JTAG pin state change at a time; it doesn't even try to buffer
 * data up to the maximum packet size of 64 bytes.
 *
 * Actually, the USB-Blaster offers a byte-shift mode to transmit up to 504 data bits
 * (bidirectional) in a single USB packet. A header byte has to be sent as the first
 * byte in a packet with the following meaning:
 *
 *   Bit 7 (0x80): Must be set to indicate byte-shift mode.
 *   Bit 6 (0x40): If set, the USB-Blaster will also read data, not just write.
 *   Bit 5..0:     Define the number N of following bytes
 *
 * All N following bytes will then be clocked out serially on TDI. If Bit 6 was set,
 * it will afterwards return N bytes with TDO data read while clocking out the TDI data.
 * LSB of the first byte after the header byte will appear first on TDI.
 */
 
/* Simple bit banging mode:
 *
 *   Bit 7 (0x80): Must be zero (see byte-shift mode above)
 *   Bit 6 (0x40): If set, you will receive a byte indicating the state of TDO in return.
 *   Bit 5 (0x20): Unknown; for now, set to one.
 *   Bit 4 (0x10): TDI Output.
 *   Bit 3 (0x08): Unknown; for now, set to one.
 *   Bit 2 (0x04): Unknown; for now, set to one.
 *   Bit 1 (0x02): TMS Output.
 *   Bit 0 (0x01): TCK Output.
 *
 * For transmitting a single data bit, you need to write two bytes. Up to 64 bytes can be
 * combined in a single USB packet (but this is not done in the code below). It isn't
 * possible to read a data without transmitting data.
 */
 
#define FTDI_TCK    0
#define FTDI_TMS    1
#define FTDI_TDI    4
#define FTDI_READ   6
#define FTDI_SHMODE 7
#define FTDI_OTHERS ((1<<2)|(1<<3)|(1<<5))
 
void usb_blaster_write(int tck, int tms, int tdi)
{
        uint8_t buf[1];
        uint32_t count;
 
        debug("---- usb_blaster_write(%d,%d,%d)\n", tck,tms,tdi);
 
        buf[0] = FTDI_OTHERS | (tck?(1<<FTDI_TCK):0) | (tms?(1<<FTDI_TMS):0) | (tdi?(1<<FTDI_TDI):0);
        usb_blaster_buf_write(buf, 1, &count);
}
 
int usb_blaster_write_read(int tck, int tms, int tdi)
{
        uint8_t buf[1];
        uint32_t count;
 
        debug("++++ usb_blaster_write_read(%d,%d,%d)\n", tck,tms,tdi);
 
        buf[0] = FTDI_OTHERS | (tck?(1<<FTDI_TCK):0) | (tms?(1<<FTDI_TMS):0) | (tdi?(1<<FTDI_TDI):0) | (1<<FTDI_READ);
        usb_blaster_buf_write(buf, 1, &count);
        usb_blaster_buf_read(buf, 1, &count);
        return (buf[0]&1);
}
 
int ftdi_usb_blaster_out(uint8_t value)
{
        int    tck = 0;
        int    tms = 0;
        int    tdi = 0;
 
        // Translate to USB blaster protocol
        // USB-Blaster has no TRST pin
        if(value & TCLK_BIT)
                tck = 1;
        if(value & TDI_BIT)
                tdi = 1;;
        if(value & TMS_BIT)
                tms = 1;
 
        usb_blaster_write(tck, tms, tdi);
 
        return 0;
}
 
int ftdi_usb_blaster_inout(uint8_t value, uint8_t *in_bit)
{
        int    tck = 0;
        int    tms = 0;
        int    tdi = 0;
 
        // Translate to USB blaster protocol
        // USB-Blaster has no TRST pin
        if(value & TCLK_BIT)
                tck = 1;
        if(value & TDI_BIT)
                tdi = 1;
        if(value & TMS_BIT)
                tms = 1;
 
        *in_bit = usb_blaster_write_read(tck, tms, tdi);
 
        return 0;
}
 
int usb_blaster_speed(int speed)
{
        if(ftdi_set_baudrate(&ftdic, speed)<0) {
                printf("Can't set baud rate to max: %s\n", ftdi_get_error_string(&ftdic));
                return -1;
        }
 
        return 0;
}
 
int ftdi_usb_blaster_init(void)
{
        uint8_t latency_timer;
        int     speed = 300000;
 
        printf("'usb_blaster' interface using libftdi.\n");
        printf("Ported by Xianfeng (xianfeng.zeng@gmail.com), 2009\n");
 
        if (ftdi_init(&ftdic) < 0) {
                printf("ftdi_init failed!");
                return -1;
        }
 
        /* context, vendor id, product id */
        if (ftdi_usb_open(&ftdic, ALTERA_VID, ALTERA_PID) < 0) {
                printf("unable to open ftdi device: %s\n", ftdic.error_str);
                return -1;
        }
 
        if (ftdi_usb_reset(&ftdic) < 0) {
                printf("unable to reset ftdi device\n");
                return -1;
        }
 
        if (ftdi_set_latency_timer(&ftdic, 2) < 0) {
                printf("unable to set latency timer\n");
                return -1;
        }
 
        if (ftdi_get_latency_timer(&ftdic, &latency_timer) < 0) {
                printf("unable to get latency timer\n");
                return -1;
        } else {
                printf("current latency timer: %i\n", latency_timer);
        }
 
        ftdi_disable_bitbang(&ftdic);
 
        printf("Baudrate:%d\n", speed);
        usb_blaster_speed(speed);
 
        return 0;
}
 
int ftdi_usb_blaster_quit(void)
{
        ftdi_usb_close(&ftdic);
        ftdi_deinit(&ftdic);
 
        return 0;
}
#endif
 
Browse

Tools

Subversion Repositories or1k_soc_on_altera_embedded_dev_kit

[/] [or1k_soc_on_altera_embedded_dev_kit/] [trunk/] [soc/] [sw/] [adv_jtag_bridge/] [cable_usbblaster.c] - Blame information for rev 12

Line No.	Rev	Author	Line
1	12	xianfeng	`/* cable_usbblaster.c - Altera USB Blaster driver for the Advanced JTAG Bridge`
2			`Copyright (C) 2008 Nathan Yawn, nathan.yawn@opencores.org`
3
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.`
8
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.`
13
14			`You should have received a copy of the GNU General Public License`
15			`along with this program; if not, write to the Free Software`
16			`Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */`
17
18
19			`#include <stdio.h>`
20			`#include <sys/types.h>`
21			`#include <unistd.h> // for usleep()`
22			`#include <stdlib.h> // for sleep()`
23			`#include <arpa/inet.h> // for htons()`
24			`#include <sys/time.h>`
25			`#include <time.h>`
26
27			`#ifdef __SUPPORT_FTDI_CABLES__`
28			`#include <ftdi.h>`
29			`#endif`
30
31			`#include "usb.h" // libusb header`
32			`#include "cable_common.h"`
33			`#include "errcodes.h"`
34
35			`#define debug(...) //fprintf(stderr, __VA_ARGS__ )`
36
37			`// USB constants for the USB Blaster`
38			`// Valid endpoints: 0x81, 0x02, 0x06, 0x88`
39			`#define EP2 0x02`
40			`#define EP1 0x81`