com.embeddedunveiled.serial.vendor.FTeeprom232R Maven / Gradle / Ivy
Show all versions of scm Show documentation
/*
* Author : Rishi Gupta
*
* This file is part of 'serial communication manager' library.
* Copyright (C) <2014-2016>
*
* This 'serial communication manager' is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* The 'serial communication manager' is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
* A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with 'serial communication manager'. If not, see Represents the C structure 'ft_eeprom_232r' declared in ftd2xx.h header file.
*
* @author Rishi Gupta
*/
public final class FTeeprom232R extends FTeepromHeader {
/* same array is shared between super class and sub class, they extract values
* from index applicable to them. */
private final int[] data232R;
/**
* 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, IsHighCurrent, useUseExtOsc,
* InvertTXD, InvertRXD, InvertRTS, InvertCTS, InvertDTR, InvertDSR, InvertDCD, InvertRI, Cbus0,
* Cbus1, Cbus2, Cbus3, Cbus4, 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).
*
* @param data array containing values of member variables for C structure.
* @throws IllegalArgumentException if data is null or its size is not equal to 24.
*/
public FTeeprom232R(int[] data) {
super(data);
if(data == null) {
throw new IllegalArgumentException("Argument data can not be null !");
}
if(data.length != 24) {
throw new IllegalArgumentException("Argument data must be of length 24 !");
}
this.data232R = data;
}
/**
* Retrieves the value of IsHighCurrent variable (drive options) in ft_eeprom_232r structure.
*
* @return non-zero if interface is high current.
*/
public int getIsHighCurrent() {
return data232R[8];
}
/**
* Retrieves the value of UseExtOsc variable (hardware options) in ft_eeprom_232r structure.
*
* @return value indicating whether external oscillator should be used or not.
*/
public int getUseExtOsc() {
return data232R[9];
}
/**
* Retrieves the value of InvertTXD variable (hardware options) in ft_eeprom_232r structure.
*
* @return non-zero if invert TXD.
*/
public int getInvertTXD() {
return data232R[10];
}
/**
* Retrieves the value of InvertRXD variable (hardware options) in ft_eeprom_232r structure.
*
* @return non-zero if invert RXD.
*/
public int getInvertRXD() {
return data232R[11];
}
/**
* Retrieves the value of InvertRTS variable (hardware options) in ft_eeprom_232r structure.
*
* @return non-zero if invert RTS.
*/
public int getInvertRTS() {
return data232R[12];
}
/**
* Retrieves the value of InvertCTS variable (hardware options) in ft_eeprom_232r structure.
*
* @return non-zero if invert CTS.
*/
public int getInvertCTS() {
return data232R[13];
}
/**
* Retrieves the value of InvertDTR variable (hardware options) in ft_eeprom_232r structure.
*
* @return non-zero if invert DTR.
*/
public int getInvertDTR() {
return data232R[14];
}
/**
* Retrieves the value of InvertDSR variable (hardware options) in ft_eeprom_232r structure.
*
* @return non-zero if invert DSR.
*/
public int getInvertDSR() {
return data232R[15];
}
/**
* Retrieves the value of InvertDCD variable (hardware options) in ft_eeprom_232r structure.
*
* @return non-zero if invert DCD.
*/
public int getInvertDCD() {
return data232R[16];
}
/**
* Retrieves the value of InvertRI variable (hardware options) in ft_eeprom_232r structure.
*
* @return non-zero if invert RI.
*/
public int getInvertRI() {
return data232R[17];
}
/**
* Retrieves the value of Cbus0 variable (hardware options) in ft_eeprom_232r structure.
*
* @return Cbus0 mux control value.
*/
public int getCbus0() {
return data232R[18];
}
/**
* Retrieves the value of Cbus1 variable (hardware options) in ft_eeprom_232r structure.
*
* @return Cbus1 mux control value.
*/
public int getCbus1() {
return data232R[19];
}
/**
* Retrieves the value of Cbus2 variable (hardware options) in ft_eeprom_232r structure.
*
* @return Cbus2 mux control value.
*/
public int getCbus2() {
return data232R[20];
}
/**
* Retrieves the value of Cbus3 variable (hardware options) in ft_eeprom_232r structure.
*
* @return Cbus3 mux control value.
*/
public int getCbus3() {
return data232R[21];
}
/**
* Retrieves the value of Cbus4 variable (hardware options) in ft_eeprom_232r structure.
*
* @return Cbus4 mux control value.
*/
public int getCbus4() {
return data232R[22];
}
/**
* Retrieves the value of DriverType variable (hardware options) in ft_eeprom_232r structure.
*
* @return driver type.
*/
public int getDriverType() {
return data232R[23];
}
/**
* Retrieves all the value defined for ft_eeprom_header and ft_eeprom_232h structures.
*
* @return array of member's values.
*/
public int[] getAllMembers() {
return data232R;
}
}