/*! Java host software API of ZTEX SDK Copyright (C) 2009-2014 ZTEX GmbH. http://www.ztex.de This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation. 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, see http://www.gnu.org/licenses/. !*/ /* USB device with ZTEX descriptor 1 and/or Cypress EZ-USB FX2 device */ package ztex; import java.io.*; import java.util.*; import ch.ntb.usb.*; /** * A class representing an EZ-USB device that supports the ZTEX descriptor 1 or an unconfigured EZ-USB device.
* Instances of this class are usually created by {@link ZtexScanBus1}. * The following table describes the ZTEX descriptor 1. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Field nameOffsetSizeDescription
ZTEX_DESCRIPTOR_SIZE01Size of the descriptor in bytes; must be 40 for descriptor version 1
ZTEX_DESCRIPTOR_VERSION11Descriptor version; 1 for version 1
ZTEXID24ID; must be "ZTEX"
PRODUCT_ID64Four numbers (0..255) representing the product ID and firmware compatibility information.
* A firmware can overwrite an installed one
*
if ( INSTALLED.PRODUCTID[0]==0 || PRODUCTID[0]==0 || INSTALLED.PRODUCTID[0]==PRODUCTID[0] ) && 
   ( INSTALLED.PRODUCTID[1]==0 || PRODUCTID[1]==0 || INSTALLED.PRODUCTID[1]==PRODUCTID[1] ) && 
   ( INSTALLED.PRODUCTID[2]==0 || PRODUCTID[2]==0 || INSTALLED.PRODUCTID[2]==PRODUCTID[2] ) && 
   ( INSTALLED.PRODUCTID[3]==0 || PRODUCTID[3]==0 || INSTALLED.PRODUCTID[3]==PRODUCTID[3] ) 
* Here is a list of the preserved product ID's: *
  * * * * * * * * * * * * *
0.0.0.0 default Product ID (no product specified)
1.*.*.* may be used for experimental purposes
10.*.*.* used for ZTEX products
10.11.*.* ZTEX USB-FPGA-Module 1.2
10.12.*.* ZTEX USB-FPGA-Module 1.11
10.13.*.* ZTEX USB-FPGA-Module 1.15 (not 1.15y)
10.14.*.* ZTEX USB-FPGA-Module 1.15x
10.15.*.* ZTEX USB-FPGA-Module 1.15y
10.20.*.* ZTEX USB-Module 1.0
10.30.*.* ZTEX USB-XMEGA-Module 1.0
10.0.1.1 ZTEX BTCMiner firmware
* Please contact us (http://www.ztex.de/contact.e.html) if you want to register or reserve a Product ID (range). *
FW_VERSION101May be used to specify the firmware version.
INTERFACE_VERSION111The interface version. This number specifies the protocol that is used for interfacing the host software. A description of interface version 1 can be found in {@link Ztex1v1}
INTERFACE_CAPABILITIES1266 bytes, each bit represents a capability. If set, the capability is supported. A description of the capabilities of interface version 1 can be found in {@link Ztex1v1}
MODULE_RESERVED181212 bytes for application specific use, i.e. they depend from the PRODUCT_ID
SN_STRING3010A serial number string of 10 characters. The default SN is "0000000000"
* @see Ztex1 * @see Ztex1v1 * @see ZtexScanBus1 */ public class ZtexDevice1 { /** * Cypress vendor ID: 0x4b4 */ public static final int cypressVendorId = 0x4b4; /** * EZ-USB USB product ID: 0x8613 */ public static final int cypressProductId = 0x8613; /** * ZTEX vendor ID: 0x221a */ public static final int ztexVendorId = 0x221A; /** * USB product ID for ZTEX devices that support ZTEX descriptor 1: 0x100. * This product ID is intended for general purpose use and can be shared by all devices that base on ZTEX modules. * Different products are identified by a second product ID, namely the PRODUCT_ID field of the ZTEX descriptor 1. *

* Please read the informations about USB vendor and product ID's. * @see #ztexProductIdMax */ public static final int ztexProductId = 0x100; /** * Largest USB product ID for ZTEX devices that support ZTEX descriptor 1: 0x1ff. * USB product ID's from {@link #ztexProductId}+1 to ztexProductIdMax (0x101 to 0x1ff) are reserved for ZTEX devices and allow to identify products without reading the ZTEX descriptor. *

* Please read the informations about USB vendor and product ID's. * @see #ztexProductId */ public static final int ztexProductIdMax = 0x1ff; private Usb_Device dev = null; private boolean valid = false; // true if descriptor 1 is available private int usbVendorId = -1; private int usbProductId = -1; private String manufacturerString = null; private String productString = null; private String snString = null; private byte productId[] = { 0,0,0,0 }; // product ID from the ZTEX descriptor, not the USB product ID private byte fwVersion = 0; private byte interfaceVersion = 0; private byte interfaceCapabilities[] = { 0,0,0,0, 0,0 }; private byte moduleReserved[] = { 0,0,0,0, 0,0,0,0, 0,0,0,0 }; // ******* byteArrayString ***************************************************** /** * Produces a nice string representation of an array of bytes. * @param buf A byte array. * @return a nice string */ public static String byteArrayString ( byte buf[] ) { String s = new String( "" ); for ( int i = 0; i * If the given vendor and product id's match to the vendor and product id's of the given USB device, * the ZTEX descriptor 1 is attempted to read. If this fails, an {@link InvalidFirmwareException} is thrown. * To suppress this behavior (e.g. if the EZ-USB device is known to be unconfigured) the vendor and product id's * can be set to -1. * @param p_dev The USB device. * @param pUsbVendorId The given vendor ID. * @param pUsbProductId The given product ID. * @param allowUnconfigured If true, unconfigured devices are allowed. * @throws UsbException if an USB communication error occurs. * @throws InvalidFirmwareException if no valid ZTEX descriptor 1 is found. * @throws DeviceNotSupported if the device has the wrong USB ID's. */ public ZtexDevice1 (Usb_Device p_dev, int pUsbVendorId, int pUsbProductId, boolean allowUnconfigured) throws UsbException, InvalidFirmwareException, DeviceNotSupportedException { dev = p_dev; Usb_Device_Descriptor dd = dev().getDescriptor(); usbVendorId = dd.getIdVendor() & 65535; usbProductId = dd.getIdProduct() & 65535; if ( ! ( ( (usbVendorId == pUsbVendorId) && (usbProductId == pUsbProductId || ( usbVendorId == ztexVendorId && pUsbProductId<0 && usbProductId>=ztexProductId && usbProductId 0 ) { if ( dd.getIManufacturer() > 0 ) manufacturerString = LibusbJava.usb_get_string_simple( handle, dd.getIManufacturer() ); if ( dd.getIProduct() > 0 ) productString = LibusbJava.usb_get_string_simple( handle, dd.getIProduct() ); if ( dd.getISerialNumber() > 0 ) snString = LibusbJava.usb_get_string_simple( handle, dd.getISerialNumber() ); if ( snString == null ) { LibusbJava.usb_close(handle); if ( allowUnconfigured ) return; else throw new InvalidFirmwareException( dev, "Not a ZTEX device" ); // ZTEX devices always have a SN. See also the next comment a few lines below } byte[] buf = new byte[42]; int i = LibusbJava.usb_control_msg(handle, 0xc0, 0x22, 0, 0, buf, 40, 500); // Failing of this may cause problems under windows. Therefore we check for the SN above. if ( i < 0 ) { LibusbJava.usb_close(handle); if ( allowUnconfigured ) return; else throw new InvalidFirmwareException( dev, "Error reading ZTEX descriptor: " + LibusbJava.usb_strerror() ); } else if ( i != 40 ) { LibusbJava.usb_close(handle); if ( allowUnconfigured ) return; else throw new InvalidFirmwareException( dev, "Error reading ZTEX descriptor: Invalid size: " + i ); } if ( buf[0]!=40 || buf[1]!=1 || buf[2]!='Z' || buf[3]!='T' || buf[4]!='E' || buf[5]!='X' ) { LibusbJava.usb_close(handle); if ( allowUnconfigured ) return; else throw new InvalidFirmwareException( dev, "Invalid ZTEX descriptor" ); } productId[0] = buf[6]; productId[1] = buf[7]; productId[2] = buf[8]; productId[3] = buf[9]; fwVersion = buf[10]; interfaceVersion = buf[11]; interfaceCapabilities[0] = buf[12]; interfaceCapabilities[1] = buf[13]; interfaceCapabilities[2] = buf[14]; interfaceCapabilities[3] = buf[15]; interfaceCapabilities[4] = buf[16]; interfaceCapabilities[5] = buf[17]; moduleReserved[0] = buf[18]; moduleReserved[1] = buf[19]; moduleReserved[2] = buf[20]; moduleReserved[3] = buf[21]; moduleReserved[4] = buf[22]; moduleReserved[5] = buf[23]; moduleReserved[6] = buf[24]; moduleReserved[7] = buf[25]; moduleReserved[8] = buf[26]; moduleReserved[9] = buf[27]; moduleReserved[10] = buf[28]; moduleReserved[11] = buf[29]; valid = true; // } // else { // throw new UsbException( dev, "Error opening device: " + LibusbJava.usb_strerror() ); // } LibusbJava.usb_close(handle); } // ******* toString ************************************************************ /** * Returns a string representation if the device with a lot of useful information. * @return a string representation if the device with a lot of useful information. */ public String toString () { return "bus=" + dev().getBus().getDirname() + " device=" + dev().getDevnum() + " (`" + dev().getFilename() + "') ID=" + Integer.toHexString(usbVendorId) + ":" + Integer.toHexString(usbProductId) +"\n" + ( manufacturerString == null ? "" : (" Manufacturer=\"" + manufacturerString + "\"") ) + ( productString == null ? "" : (" Product=\"" + productString + "\"") ) + ( snString == null ? "" : (" SerialNumber=\"" + snString + "\"") ) + ( valid ? "\n productID=" + byteArrayString(productId) + " fwVer="+(fwVersion & 255) + " ifVer="+(interfaceVersion & 255) : "" ); } // ******* compatible ********************************************************** /** * Checks whether the given product ID is compatible to the device.
* The given product ID is compatible *

if ( this.productId(0)==0 || productId0<=0 || this.productId(0)==productId0 ) && 
   ( this.productId(0)==0 || productId1<=0 || this.productId(1)==productId1 ) && 
   ( this.productId(2)==0 || productId2<=0 || this.productId(2)==productId2 ) && 
   ( this.productId(3)==0 || productId3<=0 || this.productId(3)==productId3 ) 
* @param productId0 Byte 0 of the given product ID * @param productId1 Byte 1 of the given product ID * @param productId2 Byte 2 of the given product ID * @param productId3 Byte 3 of the given product ID * @return true if the given product ID is compatible */ public final boolean compatible( int productId0, int productId1, int productId2, int productId3 ) { return ( productId[0]==0 || productId0<=0 || (productId[0] & 255) == productId0 ) && ( productId[1]==0 || productId1<=0 || (productId[1] & 255) == productId1 ) && ( productId[2]==0 || productId2<=0 || (productId[2] & 255) == productId2 ) && ( productId[3]==0 || productId3<=0 || (productId[3] & 255) == productId3 ); } // ******* dev ***************************************************************** /** * Returns the USB device. * @return the USB device. */ public final Usb_Device dev() { return dev; } // ******* valid *************************************************************** /** * Returns true if ZTEX descriptor 1 is available. * @return true if ZTEX descriptor 1 is available. */ public final boolean valid() { return valid; } // ******* usbVendorId ********************************************************* /** * Returns the USB vendor ID of the device. * @return the USB vendor ID of the device. */ public final int usbVendorId() { return usbVendorId; } // ******* usbProductId ********************************************************* /** * Returns the USB product ID of the device. * @return the USB product ID of the device. */ public final int usbProductId() { return usbProductId; } // ******* manufacturerString ************************************************** /** * Returns the manufacturer string of the device. * @return the manufacturer string of the device. */ public final String manufacturerString() { return manufacturerString; } // ******* productString ******************************************************* /** * Returns the product string of the device. * @return the product string of the device. */ public final String productString() { return productString; } // ******* snString ************************************************************ /** * Returns the serial number string of the device. * @return the serial number string of the device. */ public final String snString() { return snString; } // ******* productId *********************************************************** /** * Returns the product ID (all 4 bytes). * @return PRODUCT_ID, see above. */ public final byte[] productId() { return productId; } /** * Returns byte i of the product ID. * @return PRODUCT_ID[i], see above. * @param i index */ public int productId( int i ) { return productId[i] & 255; } // ******* fwVersion *********************************************************** /** * Returns the firmware version. * @return FW_VERSION, see above. */ public final int fwVersion() { return fwVersion & 255; } // ******* interfaceVersion ***************************************************** /** * Returns the interface version. * @return INTERFACE_VERSION, see above. */ public final int interfaceVersion() { return interfaceVersion & 255; } // ******* interfaceCapabilities ************************************************ /** * Returns the interface capabilities (all 6 bytes). * @return INTERFACE_CAPABILITIES, see above. */ public final byte[] interfaceCapabilities() { return interfaceCapabilities; } /** * Returns byte i of the interface capabilities. * @return INTERFACE_CAPABILITIES[i], see above. * @param i index */ public final int interfaceCapabilities( int i ) { return interfaceCapabilities[i] & 255; } /** * Returns byte i, bit j of the interface capabilities. * @return INTERFACE_CAPABILITIES[i].j, see above. * @param i byte index * @param j bit index */ public final boolean interfaceCapabilities( int i, int j ) { return (i>=0) && (i<=5) && (j>=0) && (j<8) && (((interfaceCapabilities[i] & 255) & (1 << j)) != 0); } // ******* moduleReserved ****************************************************** /** * Returns the application specific information (all 12 bytes). * @return MODULE_RESERVED, see above. */ public final byte[] moduleReserved() { return moduleReserved; } /** * Returns byte i of the application specific information. * @return MODULE_RESERVED[i], see above. * @param i index */ public final int moduleReserved( int i ) { return moduleReserved[i] & 255; } }

Error running this command: diff -w -U 5 "/tmp/C5xm6K" ""

diff: : No such file or directory