com.embeddedunveiled.serial.internal.SerialComFTDID2XXJNIBridge Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scm Show documentation
Show all versions of scm Show documentation
serial communication in java
The newest version!
/*
* 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 This class is an interface between java and native shared library. The native library is found
* in 'lib-vendor' folder in 'scm-x.x.x.jar' file.
*
* @author Rishi Gupta
*/
public final class SerialComFTDID2XXJNIBridge {
/**
* Allocates a new SerialComFTDID2XXJNIBridge object.
*/
public SerialComFTDID2XXJNIBridge() {
}
/**
* Extract native library from jar in a working directory, load and link it. The 'lib-vendor' folder in
* 'scm-x.x.x.jar' file is searched for the required native library for vendor specific communication. It
* also load vendor's native shared library.
*
* @param libDirectory directory in which native library will be extracted and vendor library will be found
* @param vlibName name of vendor library to load and link
* @param cpuArch architecture of CPU this library is running on
* @param osType operating system this library is running on
* @param serialComSystemProperty instance of SerialComSystemProperty to get required java properties
* @throws SerialComUnexpectedException if a critical java system property is null in system
* @throws SecurityException if any java system property can not be accessed
* @throws FileNotFoundException if the vendor library file is not found
* @throws SerialComLoadException if any file system related issue occurs
* @throws UnsatisfiedLinkError if loading/linking shared library fails
*/
public static boolean loadNativeLibrary(File libDirectory, String vlibName, int cpuArch, int osType,
SerialComSystemProperty serialComSystemProperty) throws SerialComUnexpectedException, SerialComLoadException {
String libToExtractFromJar = null;
File libFile = null;
File vlibFile = null;
InputStream input = null;
FileOutputStream output = null;
String fileSeparator = null;
fileSeparator = serialComSystemProperty.getfileSeparator();
if(fileSeparator == null) {
throw new SerialComUnexpectedException("The file.separator java system property is null in the system !");
}
/* Find the native library that will be extracted based on arch and os type */
if(cpuArch == SerialComManager.ARCH_AMD64) {
switch(osType) {
case SerialComManager.OS_WINDOWS:
libToExtractFromJar = "win_d2xx_" + SerialComManager.JAVA_LIB_VERSION + "_x86_64.dll";
break;
case SerialComManager.OS_LINUX:
libToExtractFromJar = "linux_d2xx_" + SerialComManager.JAVA_LIB_VERSION + "_x86_64.so";
break;
case SerialComManager.OS_MAC_OS_X:
libToExtractFromJar = "mac_d2xx_" + SerialComManager.JAVA_LIB_VERSION + "_x86_64.dylib";
default:
}
}else if(cpuArch == SerialComManager.ARCH_X86) {
switch(osType) {
case SerialComManager.OS_WINDOWS:
libToExtractFromJar = "win_d2xx_" + SerialComManager.JAVA_LIB_VERSION + "_x86.dll";
break;
case SerialComManager.OS_LINUX:
libToExtractFromJar = "linux_d2xx_" + SerialComManager.JAVA_LIB_VERSION + "_x86.so";
break;
case SerialComManager.OS_MAC_OS_X:
libToExtractFromJar = "mac_d2xx_" + SerialComManager.JAVA_LIB_VERSION + "_x86.dylib";
default:
}
}else {
}
/* Extract shared library from jar into working directory */
try {
libFile = new File(libDirectory.getAbsolutePath() + fileSeparator + libToExtractFromJar);
input = SerialComPortJNIBridge.class.getResourceAsStream("/lib-vendor/" + libToExtractFromJar);
output = new FileOutputStream(libFile);
if(input != null) {
int read;
byte[] buffer = new byte[4096];
while((read = input.read(buffer)) != -1){
output.write(buffer, 0, read);
}
output.flush();
output.close();
output = null;
if(!((libFile != null) && libFile.exists() && libFile.isFile())) {
throw new SerialComLoadException("Can not extract native shared library from scm-x.x.x.jar file !");
}
}else {
throw new SerialComLoadException("Can not get shared library resource as stream from scm-x.x.x.jar file using class loader !");
}
} catch (Exception e) {
throw (SerialComLoadException) new SerialComLoadException(libFile.toString()).initCause(e);
} finally {
try {
if(output != null) {
output.close();
}
} catch (Exception e) {
// ignore
}
try {
if(input != null) {
input.close();
}
} catch (Exception e) {
// ignore
}
}
// load libraries in reverse order of dependencies
try {
// vendor supplied shared library
vlibFile = new File(libDirectory.getAbsolutePath() + fileSeparator + vlibName);
System.load(vlibFile.toString());
} catch (Exception e) {
throw (UnsatisfiedLinkError) new UnsatisfiedLinkError("Could not load " + vlibFile.toString() + " native library !").initCause(e);
}
try {
// scm JNI glue shared library
System.load(libFile.toString());
} catch (Exception e) {
throw (UnsatisfiedLinkError) new UnsatisfiedLinkError("Could not load " + libFile.toString() + " native library !").initCause(e);
}
return true;
}
/* D2XX Classic Functions */
public native int setVidPid(int vid, int pid);
public native int[] getVidPid();
public native int createDeviceInfoList();
public native String[] getDeviceInfoList(int numOfDevices);
public native String[] getDeviceInfoDetail(int index);
public native String[] listDevices(int pvArg1, int dwFlags);
public native long open(int index);
public native long openEx(String serialOrDescription, long locationId, int dwFlags);
public native int close(long handle);
public native int read(long handle, byte[] buffer, int numOfBytesToRead);
public native int write(long handle, byte[] buffer, int numOfBytesToWrite);
public native int setBaudRate(long handle, int baudRate);
public native int setDivisor(long handle, int divisor);
public native int setDataCharacteristics(long handle, int dataBits, int stopBits, int parity);
public native int setTimeouts(long handle, long readTimeOut, long writeTimeOut);
public native int setFlowControl(long handle, int flctrl, byte xonch, byte xoffch);
public native int setDTR(long handle);
public native int clearDTR(long handle);
public native int setRTS(long handle);
public native int clearRTS(long handle);
public native int getModemStatus(long handle);
public native int getQueueStatus(long handle);
public native String[] getDeviceInfo(long handle);
public native long getDriverVersion(long handle);
public native long getLibraryVersion();
public native long getComPortNumber(long handle);
public native long[] getStatus(long handle);
public native int setEventNotificationAndWait(long handle, int eventMask);
public native int setChars(long handle, byte evch, byte even, byte erch, byte eren);
public native int setBreakOn(long handle);
public native int setBreakOff(long handle);
public native int purge(long handle, boolean purgeTxBuffer, boolean purgeRxBuffer);
public native int resetDevice(long handle);
public native int resetPort(long handle);
public native int cyclePort(long handle);
public native int rescan();
public native int reload(int vid, int pid);
public native int setResetPipeRetryCount(long handle, int count);
public native int stopInTask(long handle);
public native int restartInTask(long handle);
public native int setDeadmanTimeout(long handle, int count);
/* EEPROM Programming Interface Functions */
public native int readEE(long handle, int offset);
public native int writeEE(long handle, int offset, int valueToWrite);
public native int eraseEE(long handle);
public native int[] eeRead(long handle, int version, char[] manufacturer, char[] manufacturerID,
char[] description, char[] serialNumber);
// eeReadEx also calls eeRead()
public native int eeProgram(long handle, String manufacturer, String manufacturerID,
String description, String serialNumber, int[] values);
public native int eeProgramEx(long handle, String manufacturer, String manufacturerID,
String description, String serialNumber, int[] values);
public native int eeUAsize(long handle);
public native int eeUAread(long handle, byte[] buffer, int length);
public native int eeUAwrite(long handle, byte[] buffer, int length);
public native int[] eepromRead(long handle, int deviceType, char[] manufacturer,
char[] manufacturerID, char[] description, char[] serialNumber);
public native int eepromProgram(long handle, int devType, int[] dataToBeWritten,
String manufacturer, String manufacturerID, String description,
String serialNumber);
/* Extended API Functions */
public native int setLatencyTimer(long handle, int value);
public native int getLatencyTimer(long handle);
public native int setBitMode(long handle, int mask, int mode);
public native int getBitMode(long handle);
public native int setUSBParameters(long handle, int inTransferSize, int outTransferSize);
/* FT-Win32 API Functions */
public native long w32CreateFile(String serialNum, String description,
long location, int dwAttrsAndFlags, int dwAccess, boolean overLapped);
public native int w32CloseHandle(long handle);
public native int w32ReadFile(long handle, byte[] buffer, int numOfBytesToRead);
public native int w32WriteFile(long handle, byte[] buffer, int numOfBytesToWrite);
public native int w32GetOverlappedResult(long handle, boolean wait);
public native int w32EscapeCommFunction(long handle, short function);
public native int w32GetCommModemStatus(long handle);
public native int w32SetupComm(long handle, int readBufSize, int writeBufSize);
public native int w32SetCommState(long handle, int[] dcb);
public native int[] w32GetCommState(long handle);
public native int w32SetCommTimeouts(long handle, int readIntervalTimeout,
int readTotalTimeoutMultiplier, int readTotalTimeoutConstant,
int writeTotalTimeoutMultiplier, int writeTotalTimeoutConstant);
public native int[] w32GetCommTimeouts(long handle);
public native int w32SetCommBreak(long handle);
public native int w32ClearCommBreak(long handle);
public native int w32SetCommMask(long handle, int flag);
public native int w32GetCommMask(long handle);
public native int w32WaitCommEvent(long handle, int event);
public native int w32PurgeComm(long handle, int event);
public native String w32GetLastError(long handle);
public native int[] w32ClearCommError(long handle);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy