ch.ntb.inf.libusb

Class Device

java.lang.Object

ch.ntb.inf.libusb.Device

public class Device
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Device(Context ctx, java.nio.ByteBuffer nativeDevice)

Method Summary

Modifier and Type	Method and Description
boolean	allocTransfer(int isoPackets) Allocates a libusb transfer
int	bulkTransfer(int endpoint, byte[] data, int length, int timeout) initiates a bulk transfer
void	claimInterface(int interfaceNumber) claim the interface specified by its number
void	close() close this device
int	controlTransfer(byte requestType, StandardRequest request, short value, short index, byte[] data, int length, int timeout)
java.lang.String	errorName(int errorCode)
void	fillBulkStreamTransfer(int endpoint, int streamID, byte[] data, int length, java.lang.String callbackFunctionName, java.lang.Object userData, int timeout, java.lang.String fullQualifiedClassName) Fills the allocated transfer with bulk stream data
void	fillBulkTransfer(int endpoint, byte[] data, int length, java.lang.String callbackFunctionName, java.lang.Object userData, int timeout, java.lang.String fullQualifiedClassName) Fills the allocated transfer with bulk data
void	fillControlTransfer(int endpoint, byte[] data, int length, java.lang.String callbackFunctionName, java.lang.Object userData, int timeout, java.lang.String fullQualifiedClassName) Fills the allocated transfer with control data
void	fillInterruptTransfer(int endpoint, byte[] data, int length, java.lang.String callbackFunctionName, java.lang.Object userData, int timeout, java.lang.String fullQualifiedClassName) Fills the transfer with interrupt data
void	fillIsoTransfer(int endpoint, byte[] data, int length, int numIsoPackets, java.lang.String callbackFunctionName, java.lang.Object userData, int timeout, java.lang.String fullQualifiedClassName) Fills the allocated transfer with isochronous data
static void	freeList(Context ctx, boolean unrefDev) free the device list
void	freeTransfer() Frees the allocated transfer
int	getBusNumber() gives bus number where device is attached
Context	getContext() get the context this device is using
int	getDeviceAddress() get address of Device
DeviceDescriptor	getDeviceDescriptor() get device descriptor of this device
Speed	getDeviceSpeed() get negotiated device speed
static Device	getDuplicate(Context ctx, int vid, int pid, int nofDuplicate)
java.nio.ByteBuffer	getNativeDevice() get native device pointer, can't be used directly, must be wrapped through jni, so no real use for user
static int	getNofDevices() get the number of created devices
static int	getNofDuplicates()
Device	getParent() get parent Device, only valid as long as device list is not freed in native code with libusb_free_device_list!
int	getPortNumber() gives port number where device is attached
int	getPortNumbers(int[] portNumbers) gives all port numbers from device to root
java.lang.String	getStringDescriptor(int descriptorIndex, int langId) get the string descriptor of this device
java.lang.String	getStringDescriptorAscii(int descriptorIndex) get the string descriptor of this device
int	handleEvents(Context context) Eventhandler for asychnronous transfers
int	interruptTransfer(int endpoint, byte[] data, int length, int timeout) read/write data to endpoint with an interrupt transfer
boolean	isOpen() check if this device is opened
void	open() open this device
void	open(ConfigurationDescriptor cfgDesc, Interface iface, InterfaceDescriptor altSetting)
static Device	open(Context ctx, int vid, int pid) open device with following parameters
void	open(int cfgValue, int ifaceNum, int altSetting) open this device with following parameters
int	readBulk(int endpoint, byte[] data, int length, int timeout) read data from device with a bulk transfer
int	readBulk(int endpoint, byte[] data, int length, int timeout, boolean reOpenOnTimeout) read data from device with a bulk transfer, with option to reopen device on timeout and try again
int	readInterrupt(int endpoint, byte[] data, int length, int timeout)
void	releaseInterface(int interfaceNumber) release the interface specified by its number
void	reset() reset this device
static Device	search(Context ctx, int vid, int pid) search a desired device, this has limitations, if you have more than one device with the same vid, pid you get just the first in the list
void	setIsoPacketLength(int isoPacketLength) Sets the isoPacketLength of the transfer
int	submitTransfer() Submits the allocated and filled transfer
int	writeBulk(int endpoint, byte[] data, int length, int timeout) write data to device with a bulk transfer
int	writeBulk(int endpoint, byte[] data, int length, int timeout, boolean reOpenOnTimeout) write data to device with a bulk transfer, with option to reopen device on timeout and try again
int	writeInterrupt(int endpoint, byte[] data, int length, int timeout)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Device

public Device(Context ctx,
              java.nio.ByteBuffer nativeDevice)

Method Detail

search

public static Device search(Context ctx,
                            int vid,
                            int pid)
                     throws ch.ntb.inf.libusb.exceptions.LibusbException

search a desired device, this has limitations, if you have more than one device with the same vid, pid you get just the first in the list

Parameters:

ctx - context for search, if null, standard context will be used

vid - desired vid

pid - desired pid

Returns:

Device with desired parameters

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

getNofDuplicates

public static int getNofDuplicates()

getDuplicate

public static Device getDuplicate(Context ctx,
                                  int vid,
                                  int pid,
                                  int nofDuplicate)
                           throws ch.ntb.inf.libusb.exceptions.LibusbException

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

freeList

public static void freeList(Context ctx,
                            boolean unrefDev)
                     throws ch.ntb.inf.libusb.exceptions.LibusbException

free the device list

Parameters:

ctx -

unrefDev -

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

getBusNumber

public int getBusNumber()

gives bus number where device is attached

Returns:

bus number

getPortNumber

public int getPortNumber()

gives port number where device is attached

Returns:

port number

getPortNumbers

public int getPortNumbers(int[] portNumbers)
                   throws ch.ntb.inf.libusb.exceptions.LibusbException

gives all port numbers from device to root

Parameters:

portNumbers - array for portNumbers

Returns:

length of portNumbers or error number, can be ignored already thrown a LibusbException with this code

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

getParent

public Device getParent()
                 throws ch.ntb.inf.libusb.exceptions.LibusbException

get parent Device, only valid as long as device list is not freed in native code with libusb_free_device_list!

Returns:

parent Device

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

getDeviceAddress

public int getDeviceAddress()

get address of Device

Returns:

device address

getDeviceSpeed

public Speed getDeviceSpeed()

get negotiated device speed

Returns:

device speed

open

public void open()
          throws ch.ntb.inf.libusb.exceptions.LibusbException

open this device

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException - on failure

open

public static Device open(Context ctx,
                          int vid,
                          int pid)
                   throws ch.ntb.inf.libusb.exceptions.LibusbException

open device with following parameters

Parameters:

ctx - context for search, if null, standard context will be used

vid - desired vid

pid - desired pid

Returns:

device

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException - on failure or device not found

open

public void open(ConfigurationDescriptor cfgDesc,
                 Interface iface,
                 InterfaceDescriptor altSetting)
          throws ch.ntb.inf.libusb.exceptions.LibusbException

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

open

public void open(int cfgValue,
                 int ifaceNum,
                 int altSetting)
          throws ch.ntb.inf.libusb.exceptions.LibusbException

open this device with following parameters

Parameters:

cfgValue - desired configuration descriptor

ifaceNum - desired interface number

altSetting - desired alternate setting

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException - on failure

close

public void close()
           throws ch.ntb.inf.libusb.exceptions.LibusbException

close this device

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

isOpen

public boolean isOpen()

check if this device is opened

Returns:

true if open, false if closed

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor()
                                     throws ch.ntb.inf.libusb.exceptions.LibusbException

get device descriptor of this device

Returns:

DeviceDesriptor

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

reset

public void reset()
           throws ch.ntb.inf.libusb.exceptions.LibusbException

reset this device

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

controlTransfer

public int controlTransfer(byte requestType,
                           StandardRequest request,
                           short value,
                           short index,
                           byte[] data,
                           int length,
                           int timeout)
                    throws ch.ntb.inf.libusb.exceptions.LibusbException

Parameters:

requestType -

request -

value -

index -

data -

length -

timeout -

Returns:

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

bulkTransfer

public int bulkTransfer(int endpoint,
                        byte[] data,
                        int length,
                        int timeout)
                 throws ch.ntb.inf.libusb.exceptions.LibusbException

initiates a bulk transfer

Parameters:

endpoint -

data -

length -

timeout -

Returns:

number of transfered bytes

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

readBulk

public int readBulk(int endpoint,
                    byte[] data,
                    int length,
                    int timeout)
             throws ch.ntb.inf.libusb.exceptions.LibusbException

read data from device with a bulk transfer

Parameters:

endpoint -

data -

length -

timeout -

Returns:

number of read bytes

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

readBulk

public int readBulk(int endpoint,
                    byte[] data,
                    int length,
                    int timeout,
                    boolean reOpenOnTimeout)
             throws ch.ntb.inf.libusb.exceptions.LibusbException

read data from device with a bulk transfer, with option to reopen device on timeout and try again

Parameters:

endpoint -

data -

length -

timeout -

reOpenOnTimeout -

Returns:

number of read bytes

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

writeBulk

public int writeBulk(int endpoint,
                     byte[] data,
                     int length,
                     int timeout)
              throws ch.ntb.inf.libusb.exceptions.LibusbException

write data to device with a bulk transfer

Parameters:

endpoint -

data -

length -

timeout -

Returns:

number of bytes written to device

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

writeBulk

public int writeBulk(int endpoint,
                     byte[] data,
                     int length,
                     int timeout,
                     boolean reOpenOnTimeout)
              throws ch.ntb.inf.libusb.exceptions.LibusbException

write data to device with a bulk transfer, with option to reopen device on timeout and try again

Parameters:

endpoint -

data -

length -

timeout -

reOpenOnTimeout -

Returns:

number of bytes written to device

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

interruptTransfer

public int interruptTransfer(int endpoint,
                             byte[] data,
                             int length,
                             int timeout)
                      throws ch.ntb.inf.libusb.exceptions.LibusbException

read/write data to endpoint with an interrupt transfer

Parameters:

endpoint -

data -

length -

timeout -

Returns:

number of bytes written to device

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

writeInterrupt

public int writeInterrupt(int endpoint,
                          byte[] data,
                          int length,
                          int timeout)
                   throws ch.ntb.inf.libusb.exceptions.LibusbException

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

readInterrupt

public int readInterrupt(int endpoint,
                         byte[] data,
                         int length,
                         int timeout)
                  throws ch.ntb.inf.libusb.exceptions.LibusbException

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

getNofDevices

public static int getNofDevices()

get the number of created devices

Returns:

number of devices

getContext

public Context getContext()

get the context this device is using

Returns:

context

getNativeDevice

public java.nio.ByteBuffer getNativeDevice()

get native device pointer, can't be used directly, must be wrapped through jni, so no real use for user

Returns:

native device pointer

claimInterface

public void claimInterface(int interfaceNumber)
                    throws ch.ntb.inf.libusb.exceptions.LibusbException

claim the interface specified by its number

Parameters:

interfaceNumber -

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

releaseInterface

public void releaseInterface(int interfaceNumber)
                      throws ch.ntb.inf.libusb.exceptions.LibusbException

release the interface specified by its number

Parameters:

interfaceNumber -

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

getStringDescriptor

public java.lang.String getStringDescriptor(int descriptorIndex,
                                            int langId)
                                     throws ch.ntb.inf.libusb.exceptions.LibusbException

get the string descriptor of this device

Parameters:

descriptorIndex -

langId -

Returns:

string descriptor in UNICODE format, see USB Specifications

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

getStringDescriptorAscii

public java.lang.String getStringDescriptorAscii(int descriptorIndex)
                                          throws ch.ntb.inf.libusb.exceptions.LibusbException

get the string descriptor of this device

Parameters:

descriptorIndex -

Returns:

string descriptor in ASCII format

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

allocTransfer

public boolean allocTransfer(int isoPackets)
                      throws ch.ntb.inf.libusb.exceptions.LibusbException

Allocates a libusb transfer

Parameters:

isoPackets - number of iso packets

Returns:

true on success

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

fillIsoTransfer

public void fillIsoTransfer(int endpoint,
                            byte[] data,
                            int length,
                            int numIsoPackets,
                            java.lang.String callbackFunctionName,
                            java.lang.Object userData,
                            int timeout,
                            java.lang.String fullQualifiedClassName)
                     throws ch.ntb.inf.libusb.exceptions.LibusbException

Fills the allocated transfer with isochronous data

Parameters:

endpoint -

data -

length -

numIsoPackets -

callbackFunctionName -

userData -

timeout -

fullQualifiedClassName -

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

fillInterruptTransfer

public void fillInterruptTransfer(int endpoint,
                                  byte[] data,
                                  int length,
                                  java.lang.String callbackFunctionName,
                                  java.lang.Object userData,
                                  int timeout,
                                  java.lang.String fullQualifiedClassName)
                           throws ch.ntb.inf.libusb.exceptions.LibusbException

Fills the transfer with interrupt data

Parameters:

endpoint -

data -

length -

callbackFunctionName -

userData -

timeout -

fullQualifiedClassName -

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

fillBulkTransfer

public void fillBulkTransfer(int endpoint,
                             byte[] data,
                             int length,
                             java.lang.String callbackFunctionName,
                             java.lang.Object userData,
                             int timeout,
                             java.lang.String fullQualifiedClassName)
                      throws ch.ntb.inf.libusb.exceptions.LibusbException

Fills the allocated transfer with bulk data

Parameters:

endpoint -

data -

length -

callbackFunctionName -

userData -

timeout -

fullQualifiedClassName -

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

fillControlTransfer

public void fillControlTransfer(int endpoint,
                                byte[] data,
                                int length,
                                java.lang.String callbackFunctionName,
                                java.lang.Object userData,
                                int timeout,
                                java.lang.String fullQualifiedClassName)
                         throws ch.ntb.inf.libusb.exceptions.LibusbException

Fills the allocated transfer with control data

Parameters:

endpoint -

data -

length -

callbackFunctionName -

userData -

timeout -

fullQualifiedClassName -

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

fillBulkStreamTransfer

public void fillBulkStreamTransfer(int endpoint,
                                   int streamID,
                                   byte[] data,
                                   int length,
                                   java.lang.String callbackFunctionName,
                                   java.lang.Object userData,
                                   int timeout,
                                   java.lang.String fullQualifiedClassName)
                            throws ch.ntb.inf.libusb.exceptions.LibusbException

Fills the allocated transfer with bulk stream data

Parameters:

endpoint -

streamID -

data -

length -

callbackFunctionName -

userData -

timeout -

fullQualifiedClassName -

Throws:

ch.ntb.inf.libusb.exceptions.LibusbException

submitTransfer

public int submitTransfer()

Submits the allocated and filled transfer

Returns:

0 on success, libusb_error code on failure

handleEvents

public int handleEvents(Context context)

Eventhandler for asychnronous transfers

Parameters:

context -

Returns:

0 on success, libusb_error code on failure

freeTransfer

public void freeTransfer()

Frees the allocated transfer

errorName

public java.lang.String errorName(int errorCode)

Parameters:

errorCode -

Returns:

name of the error

setIsoPacketLength

public void setIsoPacketLength(int isoPacketLength)

Sets the isoPacketLength of the transfer

Parameters:

isoPacketLength -