com.serialpundit.serial.vendor

Class FTeepromXseries

java.lang.Object

com.serialpundit.serial.vendor.FTeepromData

com.serialpundit.serial.vendor.FTeepromHeader

com.serialpundit.serial.vendor.FTeepromXseries

public final class FTeepromXseries
extends FTeepromHeader

Represents the C structure 'ft_eeprom_x_series' declared in ftd2xx.h header file.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
FTeepromXseries(int[] data) Construct and allocates a new FTeeprom232R object with given details.

Method Summary

Methods

Modifier and Type	Method and Description
int	getACDriveCurrent() Retrieves the value of ACDriveCurrent variable (drive options) in ft_eeprom_x_series structure.
int	getACSchmittInput() Retrieves the value of ACSchmittInput variable (drive options) in ft_eeprom_x_series structure.
int	getACSlowSlew() Retrieves the value of ACSlowSlew variable (drive options) in ft_eeprom_x_series structure.
int	getADDriveCurrent() Retrieves the value of ADDriveCurrent variable (drive options) in ft_eeprom_x_series structure.
int	getADriverType() Retrieves the value of DriverType variable (driver options) in ft_eeprom_x_series structure.
int	getADSchmittInput() Retrieves the value of ADSchmittInput variable (drive options) in ft_eeprom_x_series structure.
int	getADSlowSlew() Retrieves the value of ADSlowSlew variable (drive options) in ft_eeprom_x_series structure.
int[]	getAllMembers() Retrieves all the value defined for ft_eeprom_header and ft_eeprom_x_series structures.
int	getBCDDisableSleep() Retrieves the value of BCDDisableSleep variable (battery charge detect options) in ft_eeprom_x_series structure.
int	getBCDEnable() Retrieves the value of BCDEnable variable (battery charge detect options) in ft_eeprom_x_series structure.
int	getBCDForceCbusPWREN() Retrieves the value of BCDForceCbusPWREN variable (battery charge detect options) in ft_eeprom_x_series structure.
int	getCbus0() Retrieves the value of Cbus0 variable (CBUS options) in ft_eeprom_x_series structure.
int	getCbus1() Retrieves the value of Cbus1 variable (CBUS options) in ft_eeprom_x_series structure.
int	getCbus2() Retrieves the value of Cbus2 variable (CBUS options) in ft_eeprom_x_series structure.
int	getCbus3() Retrieves the value of Cbus3 variable (CBUS options) in ft_eeprom_x_series structure.
int	getCbus4() Retrieves the value of Cbus4 variable (CBUS options) in ft_eeprom_x_series structure.
int	getCbus5() Retrieves the value of Cbus5 variable (CBUS options) in ft_eeprom_x_series structure.
int	getCbus6() Retrieves the value of Cbus6 variable (CBUS options) in ft_eeprom_x_series structure.
int	getFT1248Cpol() Retrieves the value of FT1248Cpol variable (FT1248 options) in ft_eeprom_x_series structure.
int	getFT1248FlowControl() Retrieves the value of FT1248FlowControl variable (FT1248 options) in ft_eeprom_x_series structure.
int	getFT1248Lsb() Retrieves the value of FT1248Lsb variable (FT1248 options) in ft_eeprom_x_series structure.
int	getI2CDeviceId() Retrieves the value of I2CDeviceId variable (I2C options) in ft_eeprom_x_series structure.
int	getI2CDisableSchmitt() Retrieves the value of I2CDisableSchmitt variable (I2C options) in ft_eeprom_x_series structure.
int	getI2CSlaveAddress() Retrieves the value of I2CSlaveAddress variable (I2C options) in ft_eeprom_x_series structure.
int	getInvertCTS() Retrieves the value of InvertCTS variable (UART signal options) in ft_eeprom_x_series structure.
int	getInvertDCD() Retrieves the value of InvertDCD variable (UART signal options) in ft_eeprom_x_series structure.
int	getInvertDSR() Retrieves the value of InvertDSR variable (UART signal options) in ft_eeprom_x_series structure.
int	getInvertDTR() Retrieves the value of InvertDTR variable (UART signal options) in ft_eeprom_x_series structure.
int	getInvertRI() Retrieves the value of InvertRI variable (UART signal options) in ft_eeprom_x_series structure.
int	getInvertRTS() Retrieves the value of InvertRTS variable (UART signal options) in ft_eeprom_x_series structure.
int	getInvertRXD() Retrieves the value of InvertRXD variable (UART signal options) in ft_eeprom_x_series structure.
int	getInvertTXD() Retrieves the value of InvertTXD variable (UART signal options) in ft_eeprom_x_series structure.
int	getPowerSaveEnable() Retrieves the value of PowerSaveEnable variable (hardware options) in ft_eeprom_x_series structure.
int	getRS485EchoSuppress() Retrieves the value of RS485EchoSuppress variable (hardware options) in ft_eeprom_x_series structure.

Methods inherited from class com.serialpundit.serial.vendor.FTeepromHeader

getDeviceType, getMaxPower, getProductID, getPullDownEnable, getRemoteWakeup, getSelfPowered, getSerNumEnable, getVendorID

Methods inherited from class java.lang.Object

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

Constructor Detail

FTeepromXseries

public FTeepromXseries(int[] data)

Construct and allocates a new FTeeprom232R object with given details.

The sequence of values must be defined in following order: deviceType, VendorId, ProductId, SerNumEnable, MaxPower, SelfPowered, RemoteWakeup, PullDownEnable, ACSlowSlew, ACSchmittInput, ACDriveCurrent, ADSlowSlew, ADSchmittInput, ADDriveCurrent, Cbus0, Cbus1, Cbus2, Cbus3, Cbus4, Cbus5, Cbus6, InvertTXD, InvertRXD, InvertRTS, InvertCTS, InvertDTR, InvertDSR, InvertDCD, InvertRI, BCDEnable, BCDForceCbusPWREN, BCDDisableSleep, I2CSlaveAddress, I2CDeviceId, I2CDisableSchmitt, FT1248Cpol, FT1248Lsb, FT1248FlowControl, RS485EchoSuppress, PowerSaveEnable, DriverType respectively.

Values should be initialized when instantiating this object for writing purpose. For reading purpose there is no need to initialize.

If the class is instantiated for writing purpose, the size of data array must be 24 and each member (value at index) must be initialized to a valid value. Although all members are of 'int data type' but deviceType must be one of the constants FT_DEVICE_XXXX, VendorId and ProductId must use lower 16 bit only, rest all the members should be 8 bit value (upper 24 bits must be all 0).

Parameters:

data - array containing values of member variables for C structure.

Throws:

IllegalArgumentException - if data is null or its size is not equal to 41.

Method Detail

getACSlowSlew

public int getACSlowSlew()

Retrieves the value of ACSlowSlew variable (drive options) in ft_eeprom_x_series structure.

Returns:

non-zero if AC bus pins have slow slew.

getACSchmittInput

public int getACSchmittInput()

Retrieves the value of ACSchmittInput variable (drive options) in ft_eeprom_x_series structure.

Returns:

non-zero if AC bus pins are Schmitt input.

getACDriveCurrent

public int getACDriveCurrent()

Retrieves the value of ACDriveCurrent variable (drive options) in ft_eeprom_x_series structure.

Returns:

driver current value (valid values are 4mA, 8mA, 12mA, 16mA).

getADSlowSlew

public int getADSlowSlew()

Retrieves the value of ADSlowSlew variable (drive options) in ft_eeprom_x_series structure.

Returns:

non-zero if AD bus pins have slow slew.

getADSchmittInput

public int getADSchmittInput()

Retrieves the value of ADSchmittInput variable (drive options) in ft_eeprom_x_series structure.

Returns:

non-zero if AD bus pins are Schmitt input.

getADDriveCurrent

public int getADDriveCurrent()

Retrieves the value of ADDriveCurrent variable (drive options) in ft_eeprom_x_series structure.

Returns:

driver current value (valid values are 4mA, 8mA, 12mA, 16mA).

getCbus0

public int getCbus0()

Retrieves the value of Cbus0 variable (CBUS options) in ft_eeprom_x_series structure.

Returns:

Cbus0 mux control value.

getCbus1

public int getCbus1()

Retrieves the value of Cbus1 variable (CBUS options) in ft_eeprom_x_series structure.

Returns:

Cbus1 mux control value.

getCbus2

public int getCbus2()

Retrieves the value of Cbus2 variable (CBUS options) in ft_eeprom_x_series structure.

Returns:

Cbus2 mux control value.

getCbus3

public int getCbus3()

Retrieves the value of Cbus3 variable (CBUS options) in ft_eeprom_x_series structure.

Returns:

Cbus3 mux control value.

getCbus4

public int getCbus4()

Retrieves the value of Cbus4 variable (CBUS options) in ft_eeprom_x_series structure.

Returns:

Cbus4 mux control value.

getCbus5

public int getCbus5()

Retrieves the value of Cbus5 variable (CBUS options) in ft_eeprom_x_series structure.

Returns:

Cbus5 mux control value.

getCbus6

public int getCbus6()

Retrieves the value of Cbus6 variable (CBUS options) in ft_eeprom_x_series structure.

Returns:

Cbus6 mux control value.

getInvertTXD

public int getInvertTXD()

Retrieves the value of InvertTXD variable (UART signal options) in ft_eeprom_x_series structure.

Returns:

non-zero if invert TXD.

getInvertRXD

public int getInvertRXD()

Retrieves the value of InvertRXD variable (UART signal options) in ft_eeprom_x_series structure.

Returns:

non-zero if invert RXD.

getInvertRTS

public int getInvertRTS()

Retrieves the value of InvertRTS variable (UART signal options) in ft_eeprom_x_series structure.

Returns:

non-zero if invert RTS.

getInvertCTS

public int getInvertCTS()

Retrieves the value of InvertCTS variable (UART signal options) in ft_eeprom_x_series structure.

Returns:

non-zero if invert CTS.

getInvertDTR

public int getInvertDTR()

Retrieves the value of InvertDTR variable (UART signal options) in ft_eeprom_x_series structure.

Returns:

non-zero if invert DTR.

getInvertDSR

public int getInvertDSR()

Retrieves the value of InvertDSR variable (UART signal options) in ft_eeprom_x_series structure.

Returns:

non-zero if invert DSR.

getInvertDCD

public int getInvertDCD()

Retrieves the value of InvertDCD variable (UART signal options) in ft_eeprom_x_series structure.

Returns:

non-zero if invert DCD.

getInvertRI

public int getInvertRI()

Retrieves the value of InvertRI variable (UART signal options) in ft_eeprom_x_series structure.

Returns:

non-zero if invert RI.

getBCDEnable

public int getBCDEnable()

Retrieves the value of BCDEnable variable (battery charge detect options) in ft_eeprom_x_series structure.

Returns:

value for battery charge enable.

getBCDForceCbusPWREN

public int getBCDForceCbusPWREN()

Retrieves the value of BCDForceCbusPWREN variable (battery charge detect options) in ft_eeprom_x_series structure.

Returns:

value indicating assert or not the power enable signal on CBUS when charging port detected.

getBCDDisableSleep

public int getBCDDisableSleep()

Retrieves the value of BCDDisableSleep variable (battery charge detect options) in ft_eeprom_x_series structure.

Returns:

value indicating whether force the device never to go into sleep mode.

getI2CSlaveAddress

public int getI2CSlaveAddress()

Retrieves the value of I2CSlaveAddress variable (I2C options) in ft_eeprom_x_series structure.

Returns:

I2C slave device address.

getI2CDeviceId

public int getI2CDeviceId()

Retrieves the value of I2CDeviceId variable (I2C options) in ft_eeprom_x_series structure.

Returns:

I2C device ID.

getI2CDisableSchmitt

public int getI2CDisableSchmitt()

Retrieves the value of I2CDisableSchmitt variable (I2C options) in ft_eeprom_x_series structure.

Returns:

value indicating disable I2C Schmitt trigger.

getFT1248Cpol

public int getFT1248Cpol()

Retrieves the value of FT1248Cpol variable (FT1248 options) in ft_eeprom_x_series structure.

Returns:

FT1248 clock polarity - clock idle high (1) or clock idle low (0).

getFT1248Lsb

public int getFT1248Lsb()

Retrieves the value of FT1248Lsb variable (FT1248 options) in ft_eeprom_x_series structure.

Returns:

FT1248 data is LSB (1) or MSB (0).

getFT1248FlowControl

public int getFT1248FlowControl()

Retrieves the value of FT1248FlowControl variable (FT1248 options) in ft_eeprom_x_series structure.

Returns:

FT1248 flow control enable value.

getRS485EchoSuppress

public int getRS485EchoSuppress()

Retrieves the value of RS485EchoSuppress variable (hardware options) in ft_eeprom_x_series structure.

Returns:

value indicating RS485EchoSuppress.

getPowerSaveEnable

public int getPowerSaveEnable()

Retrieves the value of PowerSaveEnable variable (hardware options) in ft_eeprom_x_series structure.

Returns:

value indicating power save option.

getADriverType

public int getADriverType()

Retrieves the value of DriverType variable (driver options) in ft_eeprom_x_series structure.

Returns:

driver type.

getAllMembers

public int[] getAllMembers()

Retrieves all the value defined for ft_eeprom_header and ft_eeprom_x_series structures.

Returns:

array of member's values.