|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectch.ntb.usb.LibusbJava
public class LibusbJava
This class represents the Java Native Interface to the shared library which
is (with some exceptions) a one-to-one representation of the libusb API.
| Field Summary | |
|---|---|
static int |
ERROR_BAD_FILE_DESCRIPTOR
System error codes. |
static int |
ERROR_BUSY
System error codes. |
static int |
ERROR_INVALID_PARAMETER
System error codes. |
static int |
ERROR_IO_ERROR
System error codes. |
static int |
ERROR_NO_SUCH_DEVICE_OR_ADDRESS
System error codes. |
static int |
ERROR_NOT_ENOUGH_MEMORY
System error codes. |
static int |
ERROR_SUCCESS
System error codes. |
static int |
ERROR_TIMEDOUT
System error codes. |
| Constructor Summary | |
|---|---|
LibusbJava()
|
|
| Method Summary | |
|---|---|
static int |
usb_bulk_read(long dev_handle,
int ep,
byte[] bytes,
int size,
int timeout)
Performs a bulk read request to the endpoint specified by ep. |
static int |
usb_bulk_write(long dev_handle,
int ep,
byte[] bytes,
int size,
int timeout)
Performs a bulk write request to the endpoint specified by ep. |
static int |
usb_claim_interface(long dev_handle,
int interface_)
Claim an interface of a device. |
static int |
usb_clear_halt(long dev_handle,
int ep)
Clears any halt status on an endpoint. |
static int |
usb_close(long dev_handle)
usb_close closes a device opened with
usb_open. |
static int |
usb_control_msg(long dev_handle,
int requesttype,
int request,
int value,
int index,
byte[] bytes,
int size,
int timeout)
Performs a control request to the default control pipe on a device. |
static int |
usb_find_busses()
usb_find_busses will find all of the busses on the system. |
static int |
usb_find_devices()
usb_find_devices will find all of the devices on each bus. |
static Usb_Bus |
usb_get_busses()
usb_get_busses returns a tree of descriptor objects. |
static java.lang.String |
usb_get_descriptor_by_endpoint(long dev_handle,
int ep,
byte type,
byte index,
int size)
Retrieves a descriptor from the device identified by the type and index of the descriptor from the control pipe identified by ep. |
static java.lang.String |
usb_get_descriptor(long dev_handle,
byte type,
byte index,
int size)
Retrieves a descriptor from the device identified by the type and index of the descriptor from the default control pipe. |
static java.lang.String |
usb_get_string_simple(long dev_handle,
int index)
usb_get_string_simple is a wrapper around
usb_get_string that retrieves the string description
specified by index in the first language for the descriptor. |
static java.lang.String |
usb_get_string(long dev_handle,
int index,
int langid)
Retrieves the string descriptor specified by index and langid from a device. |
static void |
usb_init()
Just like the name implies, usb_init sets up some internal
structures. |
static int |
usb_interrupt_read(long dev_handle,
int ep,
byte[] bytes,
int size,
int timeout)
Performs a interrupt read request to the endpoint specified by ep. |
static int |
usb_interrupt_write(long dev_handle,
int ep,
byte[] bytes,
int size,
int timeout)
Performs an interrupt write request to the endpoint specified by ep. |
static long |
usb_open(Usb_Device dev)
usb_open is to be used to open up a device for use. |
static int |
usb_release_interface(long dev_handle,
int interface_)
Releases a previously claimed interface |
static int |
usb_reset(long dev_handle)
Resets a device by sending a RESET down the port it is connected to. |
static int |
usb_set_altinterface(long dev_handle,
int alternate)
Sets the active alternate setting of the current interface |
static int |
usb_set_configuration(long dev_handle,
int configuration)
Sets the active configuration of a device |
static void |
usb_set_debug(int level)
Sets the debugging level of libusb. |
static java.lang.String |
usb_strerror()
Returns the error string after an error occured. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static int ERROR_SUCCESS
public static int ERROR_BAD_FILE_DESCRIPTOR
public static int ERROR_NO_SUCH_DEVICE_OR_ADDRESS
public static int ERROR_BUSY
public static int ERROR_INVALID_PARAMETER
public static int ERROR_TIMEDOUT
public static int ERROR_IO_ERROR
public static int ERROR_NOT_ENOUGH_MEMORY
| Constructor Detail |
|---|
public LibusbJava()
| Method Detail |
|---|
public static void usb_set_debug(int level)
level - 0 to 255public static void usb_init()
usb_init sets up some internal
structures. usb_init must be called before any other
libusb functions.
public static int usb_find_busses()
usb_find_busses will find all of the busses on the system.
public static int usb_find_devices()
usb_find_devices will find all of the devices on each bus.
This should be called after usb_find_busses.
public static Usb_Bus usb_get_busses()
usb_get_busses returns a tree of descriptor objects.usb_get_busses() must be called again.Usb_.
Note: The
java objects are copies of the C structs.public static long usb_open(Usb_Device dev)
usb_open is to be used to open up a device for use.
usb_open must be called before attempting to perform any
operations to the device.
dev - The device to open.
public static int usb_close(long dev_handle)
usb_close closes a device opened with
usb_open.
dev_handle - The handle to the device.
public static int usb_set_configuration(long dev_handle,
int configuration)
dev_handle - The handle to the device.configuration - The value as specified in the descriptor field
bConfigurationValue.
public static int usb_set_altinterface(long dev_handle,
int alternate)
dev_handle - The handle to the device.alternate - The value as specified in the descriptor field
bAlternateSetting.
public static int usb_clear_halt(long dev_handle,
int ep)
dev_handle - The handle to the device.ep - The value specified in the descriptor field bEndpointAddress.
public static int usb_reset(long dev_handle)
usb_reset,
the device will need to re-enumerate and thusly, requires you to find the
new device and open a new handle. The handle used to call
usb_reset will no longer work.
dev_handle - The handle to the device.
public static int usb_claim_interface(long dev_handle,
int interface_)
usb_claim_interface must be
called before you perform any operations related to this interface (like
usb_set_altinterface, usb_bulk_write, etc).
dev_handle - The handle to the device.interface_ - The value as specified in the descriptor field
bInterfaceNumber.
public static int usb_release_interface(long dev_handle,
int interface_)
dev_handle - The handle to the device.interface_ - The value as specified in the descriptor field
bInterfaceNumber.
public static int usb_control_msg(long dev_handle,
int requesttype,
int request,
int value,
int index,
byte[] bytes,
int size,
int timeout)
dev_handle - The handle to the device.requesttype - request - value - index - bytes - size - timeout -
public static java.lang.String usb_get_string(long dev_handle,
int index,
int langid)
dev_handle - The handle to the device.index - langid -
public static java.lang.String usb_get_string_simple(long dev_handle,
int index)
usb_get_string_simple is a wrapper around
usb_get_string that retrieves the string description
specified by index in the first language for the descriptor.
dev_handle - The handle to the device.index -
public static java.lang.String usb_get_descriptor(long dev_handle,
byte type,
byte index,
int size)
usb_get_descriptor_by_endpoint(long, int, byte, byte, int)
for a function that allows the control endpoint to be specified.
dev_handle - The handle to the device.type - index - size - number of charactes which will be retrieved (the length of the
resulting String)
public static java.lang.String usb_get_descriptor_by_endpoint(long dev_handle,
int ep,
byte type,
byte index,
int size)
dev_handle - The handle to the device.ep - type - index - size - number of charactes which will be retrieved (the length of the
resulting String)
public static int usb_bulk_write(long dev_handle,
int ep,
byte[] bytes,
int size,
int timeout)
dev_handle - The handle to the device.ep - bytes - size - timeout -
public static int usb_bulk_read(long dev_handle,
int ep,
byte[] bytes,
int size,
int timeout)
dev_handle - The handle to the device.ep - bytes - size - timeout -
public static int usb_interrupt_write(long dev_handle,
int ep,
byte[] bytes,
int size,
int timeout)
dev_handle - The handle to the device.ep - bytes - size - timeout -
public static int usb_interrupt_read(long dev_handle,
int ep,
byte[] bytes,
int size,
int timeout)
dev_handle - The handle to the device.ep - bytes - size - timeout -
public static java.lang.String usb_strerror()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||