rik/jlibusb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- -1 as value for alt_interface will omit the call to set_alt_interface

Browse Source 
git-svn-id: https://svn.code.sf.net/p/libusbjava/code/trunk@190 94ad28fe-ef68-46b1-9651-e7ae4fcf1c4c
This commit is contained in:
schlaepfer
2006-11-13 14:24:33 +00:00
parent 1df9b74854
commit 22d0cfe5a9
1 changed files with 530 additions and 474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

368
java/src/ch/ntb/usb/Device.java
View File

@@ -1,12 +1,10 @@
package ch.ntb.usb;
import java.util.logging.Level;
import java.util.logging.Logger;
import ch.ntb.usb.logger.LogUtil;
/**
* This class represents an USB device.<br>
* To get an instance of an USB device use <code>USB.getDevice(...)</code>.
@@ -30,7 +28,6 @@ public class Device {
private int resetTimeout = 1000;
protected Device(short idVendor, short idProduct) {
resetOnFirstOpen = false;
resetDone = false;
@@ -39,7 +36,6 @@ public class Device {
this.idProduct = idProduct;
}
/**
* Opens the device and claims the specified configuration, interface and
* altinterface.<br>
@@ -47,19 +43,24 @@ public class Device {
* read and the <code>maxPacketSize</code> value is updated. If no
* endpoints are found in the descriptors an exception is thrown.
*
* @param configuration the configuration
* @param interface_ the interface
* @param altinterface the alternative interface
* @param configuration
* the configuration
* @param interface_
* the interface
* @param altinterface
* the alternate interface. If no alternate interface must be set
* <i>-1</i> can be used.
* @throws USBException
*/
public void open(int configuration, int interface_, int altinterface) throws USBException {
public void open(int configuration, int interface_, int altinterface)
throws USBException {
this.dev_configuration = configuration;
this.dev_interface = interface_;
this.dev_altinterface = altinterface;
Usb_Bus bus;
if(usbDevHandle > 0) {
if (usbDevHandle > 0) {
throw new USBException("device opened, close or reset first");
}
@@ -69,85 +70,92 @@ public class Device {
LibusbWin.usb_find_devices();
bus = LibusbWin.usb_get_busses();
if(bus == null) {
throw new USBException("LibusbWin.usb_get_busses(): " + LibusbWin.usb_strerror());
if (bus == null) {
throw new USBException("LibusbWin.usb_get_busses(): "
+ LibusbWin.usb_strerror());
}
maxPacketSize = -1;
// search for device
while(bus != null) {
while (bus != null) {
Usb_Device dev = bus.devices;
while(dev != null) {
while (dev != null) {
Usb_Device_Descriptor devDesc = dev.descriptor;
if((devDesc.idVendor == idVendor) && (devDesc.idProduct == idProduct)) {
if ((devDesc.idVendor == idVendor)
&& (devDesc.idProduct == idProduct)) {
logger.info("Open device: " + dev.filename);
int res = LibusbWin.usb_open(dev);
if(res <= 0) {
throw new USBException("LibusbWin.usb_open: " + LibusbWin.usb_strerror());
if (res <= 0) {
throw new USBException("LibusbWin.usb_open: "
+ LibusbWin.usb_strerror());
}
usbDevHandle = res;
// get endpoint wMaxPacketSize
Usb_Config_Descriptor[] confDesc = dev.config;
for(int i = 0; i < confDesc.length; i++) {
for (int i = 0; i < confDesc.length; i++) {
Usb_Interface[] int_ = confDesc[i].interface_;
for(int j = 0; j < int_.length; j++) {
for (int j = 0; j < int_.length; j++) {
Usb_Interface_Descriptor[] intDesc = int_[j].altsetting;
for(int k = 0; k < intDesc.length; k++) {
for (int k = 0; k < intDesc.length; k++) {
Usb_Endpoint_Descriptor[] epDesc = intDesc[k].endpoint;
for(int l = 0; l < epDesc.length; l++) {
maxPacketSize = Math.max(epDesc[l].wMaxPacketSize, maxPacketSize);
for (int l = 0; l < epDesc.length; l++) {
maxPacketSize = Math.max(
epDesc[l].wMaxPacketSize,
maxPacketSize);
}
}
}
}
if(maxPacketSize <= 0) {
throw new USBException("No USB endpoints found. Check the device configuration");
if (maxPacketSize <= 0) {
throw new USBException(
"No USB endpoints found. Check the device configuration");
}
}
dev = dev.next;
}
bus = bus.next;
}
if(usbDevHandle <= 0) {
throw new USBException("USB device with idVendor 0x" + Integer.toHexString(idVendor & 0xFFFF) + " and idProduct 0x" + Integer.toHexString(idProduct & 0xFFFF) + " not found");
if (usbDevHandle <= 0) {
throw new USBException("USB device with idVendor 0x"
+ Integer.toHexString(idVendor & 0xFFFF)
+ " and idProduct 0x"
+ Integer.toHexString(idProduct & 0xFFFF) + " not found");
}
claim_interface(usbDevHandle, configuration, interface_, altinterface);
if(resetOnFirstOpen & !resetDone) {
if (resetOnFirstOpen & !resetDone) {
logger.info("reset on first open");
resetDone = true;
reset();
try {
Thread.sleep(resetTimeout);
}
catch(InterruptedException e) {
} catch (InterruptedException e) {
//
}
open(configuration, interface_, altinterface);
}
}
/**
* Release the claimed interface and close the opened device.<br>
*
* @throws USBException
*/
public void close() throws USBException {
if(usbDevHandle <= 0) {
if (usbDevHandle <= 0) {
throw new USBException("invalid device handle");
}
release_interface(usbDevHandle, dev_interface);
if(LibusbWin.usb_close(usbDevHandle) < 0) {
if (LibusbWin.usb_close(usbDevHandle) < 0) {
usbDevHandle = 0;
throw new USBException("LibusbWin.usb_close: " + LibusbWin.usb_strerror());
throw new USBException("LibusbWin.usb_close: "
+ LibusbWin.usb_strerror());
}
usbDevHandle = 0;
maxPacketSize = -1;
logger.info("device closed");
}
/**
* Sends an USB reset to the device. The device handle will no longer be
* valid. To use the device again, {@link #open(int, int, int)} must be
@@ -156,61 +164,72 @@ public class Device {
* @throws USBException
*/
public void reset() throws USBException {
if(usbDevHandle <= 0) {
if (usbDevHandle <= 0) {
throw new USBException("invalid device handle");
}
if(LibusbWin.usb_reset(usbDevHandle) < 0) {
if (LibusbWin.usb_reset(usbDevHandle) < 0) {
usbDevHandle = 0;
throw new USBException("LibusbWin.usb_reset: " + LibusbWin.usb_strerror());
throw new USBException("LibusbWin.usb_reset: "
+ LibusbWin.usb_strerror());
}
usbDevHandle = 0;
logger.info("device reset");
}
/**
* Write data to the device using a bulk transfer.<br>
*
* @param out_ep_address endpoint address to write to
* @param data data to write to this endpoint
* @param length length of the data
* @param timeout amount of time in ms the device will try to send the data
* @param out_ep_address
* endpoint address to write to
* @param data
* data to write to this endpoint
* @param length
* length of the data
* @param timeout
* amount of time in ms the device will try to send the data
* until a timeout exception is thrown
* @param reopenOnTimeout if set to true, the device will try to open the
* connection and send the data again before a timeout exception
* is thrown
* @param reopenOnTimeout
* if set to true, the device will try to open the connection and
* send the data again before a timeout exception is thrown
* @return the actual number of bytes written
* @throws USBException
*/
public int writeBulk(int out_ep_address, byte[] data, int length, int timeout, boolean reopenOnTimeout) throws USBException {
if(usbDevHandle <= 0) {
public int writeBulk(int out_ep_address, byte[] data, int length,
int timeout, boolean reopenOnTimeout) throws USBException {
if (usbDevHandle <= 0) {
throw new USBException("invalid device handle");
}
if(data == null) {
if (data == null) {
throw new USBException("data must not be null");
}
if(length <= 0) {
if (length <= 0) {
throw new USBException("size must be > 0");
}
int lenWritten = LibusbWin.usb_bulk_write(usbDevHandle, out_ep_address, data, length, timeout);
if(lenWritten < 0) {
if(lenWritten == TIMEOUT_ERROR_CODE) {
int lenWritten = LibusbWin.usb_bulk_write(usbDevHandle, out_ep_address,
data, length, timeout);
if (lenWritten < 0) {
if (lenWritten == TIMEOUT_ERROR_CODE) {
// try to reopen the device and send the data again
if(reopenOnTimeout) {
if (reopenOnTimeout) {
logger.info("try to reopen");
reset();
open(dev_configuration, dev_interface, dev_altinterface);
return writeBulk(out_ep_address, data, length, timeout, false);
return writeBulk(out_ep_address, data, length, timeout,
false);
}
throw new USBTimeoutException("LibusbWin.usb_bulk_write: " + LibusbWin.usb_strerror());
throw new USBTimeoutException("LibusbWin.usb_bulk_write: "
+ LibusbWin.usb_strerror());
}
throw new USBException("LibusbWin.usb_bulk_write: " + LibusbWin.usb_strerror());
throw new USBException("LibusbWin.usb_bulk_write: "
+ LibusbWin.usb_strerror());
}
logger.info("length written: " + lenWritten);
if(logger.isLoggable(Level.FINEST)) {
StringBuffer sb = new StringBuffer("bulkwrite, ep 0x" + Integer.toHexString(out_ep_address) + ": " + lenWritten + " Bytes sent: ");
for(int i = 0; i < lenWritten; i++) {
if (logger.isLoggable(Level.FINEST)) {
StringBuffer sb = new StringBuffer("bulkwrite, ep 0x"
+ Integer.toHexString(out_ep_address) + ": " + lenWritten
+ " Bytes sent: ");
for (int i = 0; i < lenWritten; i++) {
sb.append("0x" + String.format("%1$02X", data[i]) + " ");
}
logger.info(sb.toString());
@@ -218,50 +237,59 @@ public class Device {
return lenWritten;
}
/**
* Read data from the device using a bulk transfer.<br>
*
* @param in_ep_address endpoint address to read from
* @param data data buffer for the data to be read
* @param size the maximum requested data size
* @param timeout amount of time in ms the device will try to receive data
* until a timeout exception is thrown
* @param reopenOnTimeout if set to true, the device will try to open the
* connection and receive the data again before a timeout
* exception is thrown
* @param in_ep_address
* endpoint address to read from
* @param data
* data buffer for the data to be read
* @param size
* the maximum requested data size
* @param timeout
* amount of time in ms the device will try to receive data until
* a timeout exception is thrown
* @param reopenOnTimeout
* if set to true, the device will try to open the connection and
* receive the data again before a timeout exception is thrown
* @return the actual number of bytes read
* @throws USBException
*/
public int readBulk(int in_ep_address, byte[] data, int size, int timeout, boolean reopenOnTimeout) throws USBException {
if(usbDevHandle <= 0) {
public int readBulk(int in_ep_address, byte[] data, int size, int timeout,
boolean reopenOnTimeout) throws USBException {
if (usbDevHandle <= 0) {
throw new USBException("invalid device handle");
}
if(data == null) {
if (data == null) {
throw new USBException("data must not be null");
}
if(size <= 0) {
if (size <= 0) {
throw new USBException("size must be > 0");
}
int lenRead = LibusbWin.usb_bulk_read(usbDevHandle, in_ep_address, data, size, timeout);
if(lenRead < 0) {
if(lenRead == TIMEOUT_ERROR_CODE) {
int lenRead = LibusbWin.usb_bulk_read(usbDevHandle, in_ep_address,
data, size, timeout);
if (lenRead < 0) {
if (lenRead == TIMEOUT_ERROR_CODE) {
// try to reopen the device and send the data again
if(reopenOnTimeout) {
if (reopenOnTimeout) {
logger.info("try to reopen");
reset();
open(dev_configuration, dev_interface, dev_altinterface);
return readBulk(in_ep_address, data, size, timeout, false);
}
throw new USBTimeoutException("LibusbWin.usb_bulk_read: " + LibusbWin.usb_strerror());
throw new USBTimeoutException("LibusbWin.usb_bulk_read: "
+ LibusbWin.usb_strerror());
}
throw new USBException("LibusbWin.usb_bulk_read: " + LibusbWin.usb_strerror());
throw new USBException("LibusbWin.usb_bulk_read: "
+ LibusbWin.usb_strerror());
}
logger.info("length read: " + lenRead);
if(logger.isLoggable(Level.FINEST)) {
StringBuffer sb = new StringBuffer("bulkread, ep 0x" + Integer.toHexString(in_ep_address) + ": " + lenRead + " Bytes received: ");
for(int i = 0; i < lenRead; i++) {
if (logger.isLoggable(Level.FINEST)) {
StringBuffer sb = new StringBuffer("bulkread, ep 0x"
+ Integer.toHexString(in_ep_address) + ": " + lenRead
+ " Bytes received: ");
for (int i = 0; i < lenRead; i++) {
sb.append("0x" + String.format("%1$02X", data[i]) + " ");
}
logger.info(sb.toString());
@@ -269,50 +297,60 @@ public class Device {
return lenRead;
}
/**
* Write data to the device using a interrupt transfer.<br>
*
* @param out_ep_address endpoint address to write to
* @param data data to write to this endpoint
* @param length length of the data
* @param timeout amount of time in ms the device will try to send the data
* @param out_ep_address
* endpoint address to write to
* @param data
* data to write to this endpoint
* @param length
* length of the data
* @param timeout
* amount of time in ms the device will try to send the data
* until a timeout exception is thrown
* @param reopenOnTimeout if set to true, the device will try to open the
* connection and send the data again before a timeout exception
* is thrown
* @param reopenOnTimeout
* if set to true, the device will try to open the connection and
* send the data again before a timeout exception is thrown
* @return the actual number of bytes written
* @throws USBException
*/
public int writeInterrupt(int out_ep_address, byte[] data, int length, int timeout, boolean reopenOnTimeout) throws USBException {
if(usbDevHandle <= 0) {
public int writeInterrupt(int out_ep_address, byte[] data, int length,
int timeout, boolean reopenOnTimeout) throws USBException {
if (usbDevHandle <= 0) {
throw new USBException("invalid device handle");
}
if(data == null) {
if (data == null) {
throw new USBException("data must not be null");
}
if(length <= 0) {
if (length <= 0) {
throw new USBException("size must be > 0");
}
int lenWritten = LibusbWin.usb_interrupt_write(usbDevHandle, out_ep_address, data, length, timeout);
if(lenWritten < 0) {
if(lenWritten == TIMEOUT_ERROR_CODE) {
int lenWritten = LibusbWin.usb_interrupt_write(usbDevHandle,
out_ep_address, data, length, timeout);
if (lenWritten < 0) {
if (lenWritten == TIMEOUT_ERROR_CODE) {
// try to reopen the device and send the data again
if(reopenOnTimeout) {
if (reopenOnTimeout) {
logger.info("try to reopen");
reset();
open(dev_configuration, dev_interface, dev_altinterface);
return writeInterrupt(out_ep_address, data, length, timeout, false);
return writeInterrupt(out_ep_address, data, length,
timeout, false);
}
throw new USBTimeoutException("LibusbWin.usb_bulk_write: " + LibusbWin.usb_strerror());
throw new USBTimeoutException("LibusbWin.usb_bulk_write: "
+ LibusbWin.usb_strerror());
}
throw new USBException("LibusbWin.usb_bulk_write: " + LibusbWin.usb_strerror());
throw new USBException("LibusbWin.usb_bulk_write: "
+ LibusbWin.usb_strerror());
}
logger.info("length written: " + lenWritten);
if(logger.getLevel().intValue() <= Level.FINEST.intValue()) {
StringBuffer sb = new StringBuffer("bulkwrite, ep 0x" + Integer.toHexString(out_ep_address) + ": " + lenWritten + " Bytes sent: ");
for(int i = 0; i < lenWritten; i++) {
if (logger.getLevel().intValue() <= Level.FINEST.intValue()) {
StringBuffer sb = new StringBuffer("bulkwrite, ep 0x"
+ Integer.toHexString(out_ep_address) + ": " + lenWritten
+ " Bytes sent: ");
for (int i = 0; i < lenWritten; i++) {
sb.append("0x" + String.format("%1$02X", data[i]) + " ");
}
logger.info(sb.toString());
@@ -320,50 +358,60 @@ public class Device {
return lenWritten;
}
/**
* Read data from the device using a interrupt transfer.<br>
*
* @param in_ep_address endpoint address to read from
* @param data data buffer for the data to be read
* @param size the maximum requested data size
* @param timeout amount of time in ms the device will try to receive data
* until a timeout exception is thrown
* @param reopenOnTimeout if set to true, the device will try to open the
* connection and receive the data again before a timeout
* exception is thrown
* @param in_ep_address
* endpoint address to read from
* @param data
* data buffer for the data to be read
* @param size
* the maximum requested data size
* @param timeout
* amount of time in ms the device will try to receive data until
* a timeout exception is thrown
* @param reopenOnTimeout
* if set to true, the device will try to open the connection and
* receive the data again before a timeout exception is thrown
* @return the actual number of bytes read
* @throws USBException
*/
public int readInterrupt(int in_ep_address, byte[] data, int size, int timeout, boolean reopenOnTimeout) throws USBException {
if(usbDevHandle <= 0) {
public int readInterrupt(int in_ep_address, byte[] data, int size,
int timeout, boolean reopenOnTimeout) throws USBException {
if (usbDevHandle <= 0) {
throw new USBException("invalid device handle");
}
if(data == null) {
if (data == null) {
throw new USBException("data must not be null");
}
if(size <= 0) {
if (size <= 0) {
throw new USBException("size must be > 0");
}
int lenRead = LibusbWin.usb_interrupt_read(usbDevHandle, in_ep_address, data, size, timeout);
if(lenRead < 0) {
if(lenRead == TIMEOUT_ERROR_CODE) {
int lenRead = LibusbWin.usb_interrupt_read(usbDevHandle, in_ep_address,
data, size, timeout);
if (lenRead < 0) {
if (lenRead == TIMEOUT_ERROR_CODE) {
// try to reopen the device and send the data again
if(reopenOnTimeout) {
if (reopenOnTimeout) {
logger.info("try to reopen");
reset();
open(dev_configuration, dev_interface, dev_altinterface);
return readInterrupt(in_ep_address, data, size, timeout, false);
return readInterrupt(in_ep_address, data, size, timeout,
false);
}
throw new USBTimeoutException("LibusbWin.usb_bulk_read: " + LibusbWin.usb_strerror());
throw new USBTimeoutException("LibusbWin.usb_bulk_read: "
+ LibusbWin.usb_strerror());
}
throw new USBException("LibusbWin.usb_bulk_read: " + LibusbWin.usb_strerror());
throw new USBException("LibusbWin.usb_bulk_read: "
+ LibusbWin.usb_strerror());
}
logger.info("length read: " + lenRead);
if(logger.getLevel().intValue() <= Level.FINEST.intValue()) {
StringBuffer sb = new StringBuffer("bulkread, ep 0x" + Integer.toHexString(in_ep_address) + ": " + lenRead + " Bytes received: ");
for(int i = 0; i < lenRead; i++) {
if (logger.getLevel().intValue() <= Level.FINEST.intValue()) {
StringBuffer sb = new StringBuffer("bulkread, ep 0x"
+ Integer.toHexString(in_ep_address) + ": " + lenRead
+ " Bytes received: ");
for (int i = 0; i < lenRead; i++) {
sb.append("0x" + String.format("%1$02X", data[i]) + " ");
}
logger.info(sb.toString());
@@ -371,46 +419,60 @@ public class Device {
return lenRead;
}
/**
* Claim an interface to send and receive USB data.<br>
*
* @param usb_dev_handle the handle of the device <b>(MUST BE VALID)</b>
* @param configuration the configuration to use
* @param interface_ the interface to claim
* @param altinterface the alternative interface to use
* @throws USBException throws an USBException if the action fails
* @param usb_dev_handle
* the handle of the device <b>(MUST BE VALID)</b>
* @param configuration
* the configuration to use
* @param interface_
* the interface to claim
* @param altinterface
* the alternate interface to use. If no alternate interface must
* be set <i>-1</i> can be used.
* @throws USBException
* throws an USBException if the action fails
*/
private void claim_interface(int usb_dev_handle, int configuration, int interface_, int altinterface) throws USBException {
if(LibusbWin.usb_set_configuration(usb_dev_handle, configuration) < 0) {
throw new USBException("LibusbWin.usb_set_configuration: " + LibusbWin.usb_strerror());
private void claim_interface(int usb_dev_handle, int configuration,
int interface_, int altinterface) throws USBException {
if (LibusbWin.usb_set_configuration(usb_dev_handle, configuration) < 0) {
throw new USBException("LibusbWin.usb_set_configuration: "
+ LibusbWin.usb_strerror());
}
if(LibusbWin.usb_claim_interface(usb_dev_handle, interface_) < 0) {
throw new USBException("LibusbWin.usb_claim_interface: " + LibusbWin.usb_strerror());
if (LibusbWin.usb_claim_interface(usb_dev_handle, interface_) < 0) {
throw new USBException("LibusbWin.usb_claim_interface: "
+ LibusbWin.usb_strerror());
}
if (altinterface >= 0) {
if (LibusbWin.usb_set_altinterface(usb_dev_handle, altinterface) < 0) {
throw new USBException("LibusbWin.usb_set_altinterface: "
+ LibusbWin.usb_strerror());
}
if(LibusbWin.usb_set_altinterface(usb_dev_handle, altinterface) < 0) {
throw new USBException("LibusbWin.usb_set_altinterface: " + LibusbWin.usb_strerror());
}
logger.info("interface claimed");
}
/**
* Release a previously claimed interface.<br>
*
* @param dev_handle the handle of the device <b>(MUST BE VALID)</b>
* @param interface_ the interface to claim
* @throws USBException throws an USBException if the action fails
* @param dev_handle
* the handle of the device <b>(MUST BE VALID)</b>
* @param interface_
* the interface to claim
* @throws USBException
* throws an USBException if the action fails
*/
private void release_interface(int dev_handle, int interface_) throws USBException {
if(LibusbWin.usb_release_interface(dev_handle, interface_) < 0) {
private void release_interface(int dev_handle, int interface_)
throws USBException {
if (LibusbWin.usb_release_interface(dev_handle, interface_) < 0) {
usbDevHandle = 0;
throw new USBException("LibusbWin.usb_release_interface: " + LibusbWin.usb_strerror());
throw new USBException("LibusbWin.usb_release_interface: "
+ LibusbWin.usb_strerror());
}
logger.info("interface released");
}
/**
* Returns the product ID of the device.<br>
*
@@ -420,7 +482,6 @@ public class Device {
return idProduct;
}
/**
* Returns the vendor ID of the device.<br>
*
@@ -430,7 +491,6 @@ public class Device {
return idVendor;
}
/**
* Returns the alternative interface. This value is only valid after opening
* the device.<br>
@@ -442,7 +502,6 @@ public class Device {
return dev_altinterface;
}
/**
* Returns the current configuration used. This value is only valid after
* opening the device.<br>
@@ -454,7 +513,6 @@ public class Device {
return dev_configuration;
}
/**
* Returns the current interface. This value is only valid after opening the
* device.<br>
@@ -466,7 +524,6 @@ public class Device {
return dev_interface;
}
/**
* Returns the current device handle. This value is only valid after opening
* the device.<br>
@@ -478,7 +535,6 @@ public class Device {
return usbDevHandle;
}
/**
* Returns the maximum packet size in bytes which is allowed to be
* transmitted at once.<br>
@@ -494,7 +550,6 @@ public class Device {
return maxPacketSize;
}
/**
* Check if the device is open.<br>
* This checks only for a valid device handle. It doesn't check if the
@@ -506,7 +561,6 @@ public class Device {
return usbDevHandle > 0;
}
/**
* If enabled, the device is reset when first opened. <br>
* This will only happen once. When the application is started, the device
@@ -515,8 +569,10 @@ public class Device {
* <br>
* This feature is disabled by default.
*
* @param enable true if the device should be reset when first opened
* @param timeout the timeout between the reset and the reopening
* @param enable
* true if the device should be reset when first opened
* @param timeout
* the timeout between the reset and the reopening
*/
public void setResetOnFirstOpen(boolean enable, int timeout) {
resetOnFirstOpen = enable;