add support for different serial configurations

7 files changed, 80 insertions, 33 deletions

diff --git a/flow-binaries/linux/amd64/libflow.so.2.0 b/flow-binaries/linux/amd64/libflow.so.2.0
new file mode 100644
index 0000000..9d3912f
--- /dev/null
+++ b/flow-binaries/linux/amd64/libflow.so.2.0
diff --git a/flow-main/src/main/java/com/github/jodersky/flow/internal/NativeSerial.java b/flow-main/src/main/java/com/github/jodersky/flow/internal/NativeSerial.java
index dba3f44..e7322ed 100644
--- a/flow-main/src/main/java/com/github/jodersky/flow/internal/NativeSerial.java
+++ b/flow-main/src/main/java/com/github/jodersky/flow/internal/NativeSerial.java
@@ -12,22 +12,29 @@ class NativeSerial {
 	final static int E_IO = -1;
 	final static int E_ACCESS_DENIED = -2;
 	final static int E_BUSY = -3;
-	final static int E_INVALID_BAUD = -4;
+	final static int E_INVALID_SETTINGS = -4;
 	final static int E_INTERRUPT = -5;
 	final static int E_NO_PORT = -6;
+	
+	final static int PARITY_NONE = 0;
+	final static int PARITY_ODD = 1;
+	final static int PARITY_EVEN = 2;
 
 	/**Opens a serial port and allocates memory for storing configuration. Note: if this function fails,
 	 * any internally allocated resources will be freed.
-	 * @param port_name name of port
+	 * @param device name of port
 	 * @param baud baud rate
+	 * @param characterSize character size of data transmitted through serial device
+	 * @param twoStopBits set to use two stop bits instead of one
+	 * @param parity kind of parity checking to use
 	 * @param serial pointer to memory that will be allocated with a serial structure
 	 * @return 0 on success
 	 * @return E_NO_PORT if the given port does not exist
 	 * @return E_ACCESS_DENIED if permissions are not sufficient to open port
 	 * @return E_BUSY if port is already in use
-	 * @return E_INVALID_BAUD if specified baudrate is non-standard
+	 * @return E_INVALID_SETTINGS if any of the specified settings are not supported
 	 * @return E_IO on other error */
-	native static int open(String device, int baud, long[] serial);
+	native static int open(String device, int baud, int characterSize, boolean twoStopBits, int parity, long[] serial);
 	
 	/**Starts a blocking read from a previously opened serial port. The read is blocking, however it may be
 	 * interrupted by calling 'serial_interrupt' on the given serial port.
diff --git a/flow-main/src/main/scala/com/github/jodersky/flow/exceptions.scala b/flow-main/src/main/scala/com/github/jodersky/flow/exceptions.scala
index 0422018..f91aa1b 100644
--- a/flow-main/src/main/scala/com/github/jodersky/flow/exceptions.scala
+++ b/flow-main/src/main/scala/com/github/jodersky/flow/exceptions.scala
@@ -5,6 +5,6 @@ import java.io.IOException
 class NoSuchPortException(message: String) extends Exception(message)
 class PortInUseException(message: String) extends Exception(message)
 class AccessDeniedException(message: String) extends Exception(message)
-class IllegalBaudRateException(message: String) extends Exception(message)
+class InvalidSettingsException(message: String) extends Exception(message)
 class PortInterruptedException(message: String) extends Exception(message)
 class PortClosedException(message: String) extends Exception(message)
\ No newline at end of file
diff --git a/flow-main/src/main/scala/com/github/jodersky/flow/internal/InternalSerial.scala b/flow-main/src/main/scala/com/github/jodersky/flow/internal/InternalSerial.scala
index 315f395..f3e08b8 100644
--- a/flow-main/src/main/scala/com/github/jodersky/flow/internal/InternalSerial.scala
+++ b/flow-main/src/main/scala/com/github/jodersky/flow/internal/InternalSerial.scala
@@ -68,7 +68,7 @@ object InternalSerial {
     case E_IO => throw new IOException(port)
     case E_ACCESS_DENIED => throw new AccessDeniedException(port)
     case E_BUSY => throw new PortInUseException(port)
-    case E_INVALID_BAUD => throw new IllegalBaudRateException("use standard baud rate")
+    case E_INVALID_SETTINGS => throw new InvalidSettingsException("the provided settings are invalid: be sure to use standard baud rate, character size and parity.")
     case E_INTERRUPT => throw new PortInterruptedException(port)
     case E_NO_PORT => throw new NoSuchPortException(port)
     case error if error < 0 => throw new IOException(s"unknown error code: ${error}")
@@ -76,9 +76,9 @@ object InternalSerial {
   }
 
   /** Open a new connection to a serial port. */
-  def open(port: String, baud: Int): InternalSerial = synchronized {
+  def open(port: String, baud: Int, characterSize: Int = 8, twoStopBits: Boolean = false, parity: Int = 0): InternalSerial = synchronized {
     val pointer = new Array[Long](1)
-    except(NativeSerial.open(port, baud, pointer), port)
+    except(NativeSerial.open(port, baud, characterSize, twoStopBits, parity, pointer), port)
     new InternalSerial(port, pointer(0))
   }
 
diff --git a/flow-native/shared/include/flow.h b/flow-native/shared/include/flow.h
index eacc783..ebb845a 100644
--- a/flow-native/shared/include/flow.h
+++ b/flow-native/shared/include/flow.h
@@ -3,13 +3,17 @@
 
 #include <stdbool.h>
 
-//general error codes that are meant to be communicated to user
+//general error codes that are returned by functions
 #define E_IO -1 //I/O error (port should be closed)
 #define E_ACCESS_DENIED -2 //access denied
 #define E_BUSY -3 // port is busy
-#define E_INVALID_BAUD -4 // baud rate is not valid
+#define E_INVALID_SETTINGS -4 // some port settings are invalid
 #define E_INTERRUPT -5 // not really an error, function call aborted because port is closed
-#define E_NO_PORT -6
+#define E_NO_PORT -6 //requested port does not exist
+
+#define PARITY_NONE 0
+#define PARITY_ODD 1
+#define PARITY_EVEN 2
 
 /** Represents an open serial port. */
 struct serial_config;
@@ -18,14 +22,23 @@ struct serial_config;
  * any internally allocated resources will be freed.
  * @param port_name name of port
  * @param baud baud rate
+ * @param char_size character size of data transmitted through serial device
+ * @param two_stop_bits set to use two stop bits instead of one
+ * @param parity kind of parity checking to use
  * @param serial pointer to memory that will be allocated with a serial structure
  * @return 0 on success
  * @return E_NO_PORT if the given port does not exist
  * @return E_ACCESS_DENIED if permissions are not sufficient to open port
  * @return E_BUSY if port is already in use
- * @return E_INVALID_BAUD if specified baudrate is non-standard
+ * @return E_INVALID_SETTINGS if any of the specified settings are not supported
  * @return E_IO on other error */
-int serial_open(const char* port_name, int baud, struct serial_config** serial);
+int serial_open(
+  const char* port_name,
+  int baud,
+  int char_size,
+  bool two_stop_bits,
+  int parity,
+  struct serial_config** serial);
 
 /**Closes a previously opened serial port and frees memory containing the configuration. Note: after a call to
  * this function, the 'serial' pointer will become invalid, make sure you only call it once. This function is NOT
diff --git a/flow-native/unix/src/flow.c b/flow-native/unix/src/flow.c
index 29769d3..07e1c9f 100644
--- a/flow-native/unix/src/flow.c
+++ b/flow-native/unix/src/flow.c
@@ -57,7 +57,13 @@ struct serial_config {
   
 };
 
-int serial_open(const char* port_name, int baud, struct serial_config** serial) {
+int serial_open(
+  const char* port_name,
+  int baud,
+  int char_size,
+  bool two_stop_bits,
+  int parity,
+  struct serial_config** serial) {
   
   int fd = open(port_name, O_RDWR | O_NOCTTY | O_NONBLOCK);
   
@@ -75,6 +81,15 @@ int serial_open(const char* port_name, int baud, struct serial_config** serial)
     return E_BUSY;
   }
   
+  /* configure new port settings */
+  struct termios newtio;
+  
+  newtio.c_cflag = 0;
+  newtio.c_oflag = 0;
+  newtio.c_iflag = 0;
+  newtio.c_lflag = 0;
+  
+  /* set speed */
   speed_t bd;
   switch (baud) {
     case 50: bd = B50; break;
@@ -97,29 +112,41 @@ int serial_open(const char* port_name, int baud, struct serial_config** serial)
     case 230400: bd = B230400; break;
     default:
       close(fd);
-      return E_INVALID_BAUD;
-      break;
+      return E_INVALID_SETTINGS;
   }
-
-  /* configure new port settings */
-  struct termios newtio;
-  newtio.c_cflag &= ~(PARENB | CSTOPB | CSIZE | CRTSCTS); // 8N1
-  newtio.c_cflag |= CS8 | CREAD | CLOCAL;
-  newtio.c_iflag &= ~(IXON | IXOFF | IXANY); // turn off s/w flow ctrl
-  newtio.c_lflag &= ~(ICANON | ECHO | ECHOE | ISIG); // make raw
-  newtio.c_oflag &= ~OPOST; // make raw
-
-  //see: http://unixwiz.net/techtips/termios-vmin-vtime.html
-  //newtio.c_cc[VMIN] = 1;
-  //newtio.c_cc[VTIME] = 2*10/baud;
   
   if (cfsetspeed(&newtio, bd) < 0) {
     DEBUG(perror("set baud rate"););
     close(fd);
     return E_IO;
   }
+
+  /* set char size*/
+  switch (char_size) {
+    case 5: newtio.c_cflag |= CS5; break;
+    case 6: newtio.c_cflag |= CS6; break;
+    case 7: newtio.c_cflag |= CS7; break;
+    case 8: newtio.c_cflag |= CS8; break;
+    default:
+      close(fd);
+      return E_INVALID_SETTINGS;
+  }
+  
+  /* use two stop bits */
+  if (two_stop_bits){
+    newtio.c_cflag |= CSTOPB;
+  }
+  
+  /* set parity */
+  switch (parity) {
+    case PARITY_NONE: break;
+    case PARITY_ODD: newtio.c_cflag |= (PARENB | PARODD); break;
+    case PARITY_EVEN: newtio.c_cflag |= PARENB; break;
+    default:
+      close(fd);
+      return E_INVALID_SETTINGS;
+  }
   
-  /* load new settings to port */
   if (tcflush(fd, TCIOFLUSH) < 0) {
     DEBUG(perror("flush serial settings"););
     close(fd);
@@ -255,11 +282,11 @@ inline jlong s2j(struct serial_config* pointer) {
 }
 
 JNIEXPORT jint JNICALL Java_com_github_jodersky_flow_internal_NativeSerial_open
-  (JNIEnv *env, jclass clazz, jstring port_name, jint baud, jlongArray jserialp)
+  (JNIEnv *env, jclass clazz, jstring port_name, jint baud, jint char_size, jboolean two_stop_bits, jint parity, jlongArray jserialp)
 { 
   const char *dev = (*env)->GetStringUTFChars(env, port_name, 0);
   struct serial_config* serial;
-  int r = serial_open(dev, baud, &serial);
+  int r = serial_open(dev, baud, char_size, two_stop_bits, parity, &serial);
   (*env)->ReleaseStringUTFChars(env, port_name, dev);
   
   long serialp = s2j(serial);
diff --git a/project/Build.scala b/project/Build.scala
index 7bd5196..c4b301f 100644
--- a/project/Build.scala
+++ b/project/Build.scala
@@ -8,7 +8,7 @@ import JniKeys._
 object FlowBuild extends Build {
   val Organization = "com.github.jodersky"
   val Version = "1.0-SNAPSHOT" //version of flow library
-  val BinaryMajorVersion = 1 //binary major version used to select so's and dlls when publishing (needs to be incremented if API changes are made to flow.h or NativeSerial.java)
+  val BinaryMajorVersion = 2 //binary major version used to select so's and dlls when publishing (needs to be incremented if API changes are made to flow.h or NativeSerial.java)
   val ScalaVersion = "2.10.1"
   //see native settings down below
   
@@ -106,7 +106,7 @@ val binaries: Seq[(File, File)] = getLatestBinaries(binDir, BinaryMajorVersion)
     
   //--- native unix-like settings ----------------------------------------
   
-  val UnixBinaryMinorVersion = 1
+  val UnixBinaryMinorVersion = 0
   
   lazy val unixNativeSettings: Seq[Setting[_]] = commonNativeSettings ++ Seq(
     flags in Native := Seq("-fPIC", "-O2")