org.minetti.astrodevice.server.usb.jni
Interface UsbDeviceTreeBuilder

All Known Implementing Classes:

UsbDeviceTreeBuilderImpl

public interface UsbDeviceTreeBuilder

Builder of device tree.

Author:

Jean-Philippe MINETTI

Method Summary

void	add(int vendorId, int productId, String manufacturerName, String productDescription, int productVersion, String serialNumber, short deviceClass, short deviceSubClass, short deviceProtocol) Adds a new device in the tree.
void	addHostController(String description) Adds a new USB host controller.
void	addHub(int vendorId, int productId, String manufacturerName, String productDescription, int productVersion, String serialNumber, short deviceClass, short deviceSubClass, short deviceProtocol) Adds a new hub in the tree.
void	addRootHub() Adds a new root hub in the tree.
void	down() Downs from the device tree.
void	up() Ups from the device tree.

Method Detail

down

void down()

Downs from the device tree.

up

void up()

Ups from the device tree.

addHostController

void addHostController(String description)

Adds a new USB host controller.

Parameters:

description - Description of USB host controller.

addRootHub

void addRootHub()

Adds a new root hub in the tree.

addHub

void addHub(int vendorId,
            int productId,
            String manufacturerName,
            String productDescription,
            int productVersion,
            String serialNumber,
            short deviceClass,
            short deviceSubClass,
            short deviceProtocol)

Adds a new hub in the tree.

Parameters:

vendorId - Vendor ID of USB hub (must be between 0 and 65535). This corresponds to idVendor field of USB specification (assigned by the USB-IF).

productId - Product ID of USB hub (must be between 0 and 65535). This corresponds to idProduct field of USB specification (assigned by the manufacturer).

manufacturerName - Manufacturer name of USB hub (must be less or equal than 127 characters). This corresponds to string indexed by the iManufacturer field of USB specification.

productDescription - Product description of USB hub (must be less or equal than 127 characters). This corresponds to string indexed by the iProduct field of USB specification.

productVersion - Product version of USB hub (must be between 0 and 65535). This corresponds to bcdDevice field of USB specification (assigned by the manufacturer).

serialNumber - Serial number of USB hub (must be less or equal than 127 characters). This corresponds to string indexed by the iSerialNumber field of USB specification.

deviceClass - Class code of USB hub (must be between 0 and 255). This corresponds to bDeviceClass field of USB specification (assigned by the USB-IF).

deviceSubClass - Subclass code of USB hub (must be between 0 and 255). This corresponds to bDeviceSubClass field of USB specification (assigned by the USB-IF).

deviceProtocol - Protocol code of USB hub (must be between 0 and 255). This corresponds to bDeviceProtocol field of USB specification (assigned by the USB-IF).

add

void add(int vendorId,
         int productId,
         String manufacturerName,
         String productDescription,
         int productVersion,
         String serialNumber,
         short deviceClass,
         short deviceSubClass,
         short deviceProtocol)

Adds a new device in the tree.

Parameters:

vendorId - Vendor ID of USB device (must be between 0 and 65535). This corresponds to idVendor field of USB specification (assigned by the USB-IF).

productId - Product ID of USB device (must be between 0 and 65535). This corresponds to idProduct field of USB specification (assigned by the manufacturer).

manufacturerName - Manufacturer name of USB device (must be less or equal than 127 characters). This corresponds to string indexed by the iManufacturer field of USB specification.

productDescription - Product description of USB device (must be less or equal than 127 characters). This corresponds to string indexed by the iProduct field of USB specification.

productVersion - Product version of USB device (must be between 0 and 65535). This corresponds to bcdDevice field of USB specification (assigned by the manufacturer).

serialNumber - Serial number of USB device (must be less or equal than 127 characters). This corresponds to string indexed by the iSerialNumber field of USB specification.

deviceClass - Class code of USB device (must be between 0 and 255). This corresponds to bDeviceClass field of USB specification (assigned by the USB-IF).

deviceSubClass - Subclass code of USB device (must be between 0 and 255). This corresponds to bDeviceSubClass field of USB specification (assigned by the USB-IF).

deviceProtocol - Protocol code of USB device (must be between 0 and 255). This corresponds to bDeviceProtocol field of USB specification (assigned by the USB-IF).