org.lsst.ccs.drivers.usb

Class UsbDevice

java.lang.Object

org.lsst.ccs.drivers.usb.UsbDevice

public class UsbDevice
extends Object

Operations for a USB device

Author:

Owen Saxton

Method Summary

Modifier and Type	Method and Description
void	attachDriver(int ifcnum) Re-attaches a kernel driver to an interface.
void	bulkFlush(int endp) Flushes bulk data from an endpoint.
int	bulkRead(int endp, byte[] data, int offset, int leng, int timeout) Reads bulk data from an endpoint.
int	bulkWrite(int endp, byte[] data, int offset, int leng, int timeout) Writes bulk data to an endpoint.
void	claimInterface(int ifcnum, boolean force) Claims an interface.
void	close() Closes the device.
int	controlRead(int type, int rqst, int value, int index, byte[] data, int offset, int leng, int timeout) Reads from a control endpoint.
int	controlWrite(int type, int rqst, int value, int index, byte[] data, int offset, int leng, int timeout) Writes to a control endpoint.
void	detachDriver(int ifcnum) Detaches a kernel driver from an interface.
UsbConfiguration	getActiveConfiguration() Gets the active configuration.
int	getActiveConfigurationNumber() Gets the active configuration number.
int	getAddress() Gets the device address.
int	getAltSetting(int ifcnum) Gets an alternate setting.
int	getBusNumber() Gets the bus number.
UsbConfiguration	getConfiguration(int index) Gets a configuration by its index.
UsbConfiguration	getConfigurationByValue(int value) Gets a configuration by its value.
List<UsbConfiguration>	getConfigurations() Gets the list of available configurations.
UsbDeviceDescriptor	getDescriptor() Gets the device descriptor.
String	getManufacturer() Gets the manufacturer string.
int	getPortNumber() Gets the port number.
String	getProduct() Gets the product string.
String	getSerialNumber() Gets the serial number string.
int	getSpeed() Gets the negotiated device speed.
String	getString(int index) Gets a string (descriptor).
int	interruptRead(int endp, byte[] data, int offset, int leng, int timeout) Reads interrupt data from an endpoint.
int	interruptWrite(int endp, byte[] data, int offset, int leng, int timeout) Writes interrupt data to an endpoint.
void	releaseInterface(int ifcnum) Releases an interface.
void	reset() Resets the device.
void	setActiveConfiguration(int cfgnum) Sets the active configuration (by number).
void	setAltSetting(int ifcnum, int altnum) Selects an alternate setting.
void	setAutoDetachDriver(boolean enable) Sets the auto-detach kernel driver option.

Methods inherited from class java.lang.Object

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

Method Detail

getDescriptor

public UsbDeviceDescriptor getDescriptor()

Gets the device descriptor.

Returns:

The device descriptor

getBusNumber

public int getBusNumber()

Gets the bus number.

Returns:

The bus number

getPortNumber

public int getPortNumber()

Gets the port number.

Returns:

The port number

getAddress

public int getAddress()

Gets the device address.

Returns:

The device address

getSpeed

public int getSpeed()

Gets the negotiated device speed.

Returns:

The device's speed

getConfigurations

public List<UsbConfiguration> getConfigurations()
                                         throws org.lsst.ccs.drivers.commons.DriverException

Gets the list of available configurations.

Returns:

The list of configurations

Throws:

org.lsst.ccs.drivers.commons.DriverException

getActiveConfiguration

public UsbConfiguration getActiveConfiguration()
                                        throws org.lsst.ccs.drivers.commons.DriverException

Gets the active configuration.

Returns:

The active configuration

Throws:

org.lsst.ccs.drivers.commons.DriverException

getConfiguration

public UsbConfiguration getConfiguration(int index)
                                  throws org.lsst.ccs.drivers.commons.DriverException

Gets a configuration by its index.

Parameters:

index - The index of the configuration

Returns:

The configuration

Throws:

org.lsst.ccs.drivers.commons.DriverException

getConfigurationByValue

public UsbConfiguration getConfigurationByValue(int value)
                                         throws org.lsst.ccs.drivers.commons.DriverException

Gets a configuration by its value.

Parameters:

value - The configuration value

Returns:

The configuration

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

public void close()

Closes the device.

getActiveConfigurationNumber

public int getActiveConfigurationNumber()
                                 throws org.lsst.ccs.drivers.commons.DriverException

Gets the active configuration number.

Returns:

The active configuration number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setActiveConfiguration

public void setActiveConfiguration(int cfgnum)
                            throws org.lsst.ccs.drivers.commons.DriverException

Sets the active configuration (by number).

Parameters:

cfgnum - The configuration number

Throws:

org.lsst.ccs.drivers.commons.DriverException

claimInterface

public void claimInterface(int ifcnum,
                           boolean force)
                    throws org.lsst.ccs.drivers.commons.DriverException

Claims an interface.

Parameters:

ifcnum - The interface number

force - Whether to force the claim

Throws:

org.lsst.ccs.drivers.commons.DriverException

releaseInterface

public void releaseInterface(int ifcnum)
                      throws org.lsst.ccs.drivers.commons.DriverException

Releases an interface.

Parameters:

ifcnum - The interface number

Throws:

org.lsst.ccs.drivers.commons.DriverException

detachDriver

public void detachDriver(int ifcnum)
                  throws org.lsst.ccs.drivers.commons.DriverException

Detaches a kernel driver from an interface.

Parameters:

ifcnum - The interface number

Throws:

org.lsst.ccs.drivers.commons.DriverException

attachDriver

public void attachDriver(int ifcnum)
                  throws org.lsst.ccs.drivers.commons.DriverException

Re-attaches a kernel driver to an interface.

Parameters:

ifcnum - The interface number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setAutoDetachDriver

public void setAutoDetachDriver(boolean enable)
                         throws org.lsst.ccs.drivers.commons.DriverException

Sets the auto-detach kernel driver option.

Parameters:

enable - Whether to enable the auto-detach option

Throws:

org.lsst.ccs.drivers.commons.DriverException

setAltSetting

public void setAltSetting(int ifcnum,
                          int altnum)
                   throws org.lsst.ccs.drivers.commons.DriverException

Selects an alternate setting.

Parameters:

ifcnum - The interface number

altnum - The alternate setting number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAltSetting

public int getAltSetting(int ifcnum)

Gets an alternate setting.

Parameters:

ifcnum - The interface number

Returns:

The alternate setting number, or 0 if the interface number doesn't exist

getString

public String getString(int index)

Gets a string (descriptor).

Parameters:

index - The index of the string

Returns:

The string, or null if the index is invalid

getManufacturer

public String getManufacturer()

Gets the manufacturer string.

Returns:

The manufacturer string

getProduct

public String getProduct()

Gets the product string.

Returns:

The product string

getSerialNumber

public String getSerialNumber()

Gets the serial number string.

Returns:

The serial number string

reset

public void reset()
           throws org.lsst.ccs.drivers.commons.DriverException

Resets the device.

Throws:

org.lsst.ccs.drivers.commons.DriverException

controlRead

public int controlRead(int type,
                       int rqst,
                       int value,
                       int index,
                       byte[] data,
                       int offset,
                       int leng,
                       int timeout)
                throws org.lsst.ccs.drivers.commons.DriverException

Reads from a control endpoint.

Parameters:

type - The transfer type

rqst - The request parameter

value - The value parameter

index - The index parameter

data - The array to which the data is read

offset - The offset to the start of the read data

leng - The number of bytes to read

timeout - The timeout (ms)

Returns:

The number of bytes read

Throws:

org.lsst.ccs.drivers.commons.DriverException

controlWrite

public int controlWrite(int type,
                        int rqst,
                        int value,
                        int index,
                        byte[] data,
                        int offset,
                        int leng,
                        int timeout)
                 throws org.lsst.ccs.drivers.commons.DriverException

Writes to a control endpoint.

Parameters:

type - The transfer type

rqst - The request parameter

value - The value parameter

index - The index parameter

data - The array from which the data is written

offset - The offset to the start of the data

leng - The number of bytes to write

timeout - The timeout (ms)

Returns:

The number of bytes written

Throws:

org.lsst.ccs.drivers.commons.DriverException

bulkRead

public int bulkRead(int endp,
                    byte[] data,
                    int offset,
                    int leng,
                    int timeout)
             throws org.lsst.ccs.drivers.commons.DriverException

Reads bulk data from an endpoint.

Parameters:

endp - The endpoint address.

data - The array to which the data is read

offset - The offset to the start of the read data

leng - The number of bytes to read

timeout - The timeout (ms)

Returns:

The number of bytes read

Throws:

org.lsst.ccs.drivers.commons.DriverException

bulkFlush

public void bulkFlush(int endp)
               throws org.lsst.ccs.drivers.commons.DriverException

Flushes bulk data from an endpoint.

Parameters:

endp - The endpoint address.

Throws:

org.lsst.ccs.drivers.commons.DriverException

bulkWrite

public int bulkWrite(int endp,
                     byte[] data,
                     int offset,
                     int leng,
                     int timeout)
              throws org.lsst.ccs.drivers.commons.DriverException

Writes bulk data to an endpoint.

Parameters:

endp - The endpoint address.

data - The array from which the data is written

offset - The offset to the start of the written data

leng - The number of bytes to write

timeout - The timeout (ms)

Returns:

The number of bytes written

Throws:

org.lsst.ccs.drivers.commons.DriverException

interruptRead

public int interruptRead(int endp,
                         byte[] data,
                         int offset,
                         int leng,
                         int timeout)
                  throws org.lsst.ccs.drivers.commons.DriverException

Reads interrupt data from an endpoint.

Parameters:

endp - The endpoint address.

data - The array to which the data is read

offset - The offset to the start of the read data

leng - The number of bytes to read

timeout - The timeout (ms)

Returns:

The number of bytes read

Throws:

org.lsst.ccs.drivers.commons.DriverException

interruptWrite

public int interruptWrite(int endp,
                          byte[] data,
                          int offset,
                          int leng,
                          int timeout)
                   throws org.lsst.ccs.drivers.commons.DriverException

Writes interrupt data to an endpoint.

Parameters:

endp - The endpoint address.

data - The array from which the data is written

offset - The offset to the start of the written data

leng - The number of bytes to write

timeout - The timeout (ms)

Returns:

The number of bytes written

Throws:

org.lsst.ccs.drivers.commons.DriverException