让android_serialport_api支持奇偶校验、数据位、停止位等参数

公司承接了几个产品设计项目，都涉及到用Android开发用户界面，并用串口操控设备。

我们采购的单板机上有多个串口，遗憾的是Android默认不支持。

经多方查找，选择了android_serialport_api(官方下载地址：http://code.google.com/p/android-serialport-api/)。

这个类库倒是简单，就是通过jni调用c底层方法读写linux的串口文件。不过阅读这个类库的源代码，发现android_seiralport_api仅支持自定义波特率，其他三个常用的串口参数（奇偶校验、数据位、停止位）只能使用默认值。

原始代码SerialPort.java中的构造函数：

public SerialPort(File device, int baudrate, int flags) throws SecurityException, IOException

原始代码SerialPort.c中的打开串口的函数：

JNIEXPORT jobject JNICALL Java_com_cosin_serialport_SerialPort_open (JNIEnv *env, jclass thiz, jstring path, jint baudrate, jint flags)

这在多数情况下可能没问题，不过我们项目却要求采用不同于默认值的串口策略。所以我改动了（很少）部分代码，让这个类库支持奇偶校验、数据位、停止位这三个常用参数。

修改过的SerialPort.java:

/*
 * Copyright 2009 Cedric Priscal
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. 
 */

package android_serialport_api;

import java.io.File;
import java.io.FileDescriptor;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import android.util.Log;

public class SerialPort {

	private static final String TAG = "SerialPort";

	/*
	 * Do not remove or rename the field mFd: it is used by native method close();
	 */
	private FileDescriptor mFd;
	private FileInputStream mFileInputStream;
	private FileOutputStream mFileOutputStream;

	public SerialPort(File device) throws SecurityException, IOException {
		this(device, 9600, 0, 8, 1);
	}
	/**
	 * 打开串口
	 *@param device 串口设备文件
	 *@param baudrate 波特率，一般是9600
	 *@param parity 奇偶校验，0 None, 1 Odd, 2 Even
	 *@param dataBits 数据位，5 - 8
	 *@param stopBit 停止位，1 或 2
	 */
	public SerialPort(File device, int baudrate, int parity, int dataBits, int stopBit) throws SecurityException, IOException {
		/* Check access permission */
		if (!device.canRead() || !device.canWrite()) {
			try {
				/* Missing read/write permission, trying to chmod the file */
				Process su;
				su = Runtime.getRuntime().exec("/system/bin/su");
				String cmd = "chmod 666 " + device.getAbsolutePath() + "\n"
						+ "exit\n";
				su.getOutputStream().write(cmd.getBytes());
				if ((su.waitFor() != 0) || !device.canRead()
						|| !device.canWrite()) {
					throw new SecurityException();
				}
			} catch (Exception e) {
				e.printStackTrace();
				throw new SecurityException();
			}
		}

		mFd = open(device.getAbsolutePath(), baudrate, parity, dataBits, stopBit);
		if (mFd == null) {
			Log.e(TAG, "native open returns null");
			throw new IOException();
		}
		mFileInputStream = new FileInputStream(mFd);
		mFileOutputStream = new FileOutputStream(mFd);
	}

	// Getters and setters
	public InputStream getInputStream() {
		return mFileInputStream;
	}

	public OutputStream getOutputStream() {
		return mFileOutputStream;
	}

	// JNI
	private native static FileDescriptor open(String path, int baudrate, int parity, int dataBits, int stopBit);
	public native void close();
	static {
		try {
			System.loadLibrary("serial_port");
		}
		catch ( Exception ex){
			ex.printStackTrace();
		}
	}
}

修改过的SerialPort.c:

/*
 * Copyright 2009-2011 Cedric Priscal
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <termios.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <jni.h>

#include "SerialPort.h"

#include "android/log.h"
static const char *TAG="serial_port";

static speed_t getBaudrate(jint baudrate)
{
	switch(baudrate) {
	case 0: return B0;
	case 50: return B50;
	case 75: return B75;
	case 110: return B110;
	case 134: return B134;
	case 150: return B150;
	case 200: return B200;
	case 300: return B300;
	case 600: return B600;
	case 1200: return B1200;
	case 1800: return B1800;
	case 2400: return B2400;
	case 4800: return B4800;
	case 9600: return B9600;
	case 19200: return B19200;
	case 38400: return B38400;
	case 57600: return B57600;
	case 115200: return B115200;
	case 230400: return B230400;
	case 460800: return B460800;
	case 500000: return B500000;
	case 576000: return B576000;
	case 921600: return B921600;
	case 1000000: return B1000000;
	case 1152000: return B1152000;
	case 1500000: return B1500000;
	case 2000000: return B2000000;
	case 2500000: return B2500000;
	case 3000000: return B3000000;
	case 3500000: return B3500000;
	case 4000000: return B4000000;
	default: return -1;
	}
}

static void throwException(JNIEnv *env, const char *name, const char *msg)
{
    jclass cls = (*env)->FindClass(env, name);
    /* if cls is NULL, an exception has already been thrown */
    if (cls != NULL) {
        (*env)->ThrowNew(env, cls, msg);
    }

    /* free the local ref */
    (*env)->DeleteLocalRef(env, cls);
}

/*
 * Class:     android_serialport_SerialPort
 * Method:    open
 * Signature: (Ljava/lang/String;II)Ljava/io/FileDescriptor;
 */
JNIEXPORT jobject JNICALL Java_android_1serialport_1api_SerialPort_open
  (JNIEnv *env, jclass thiz, jstring path, jint baudrate, jint parity, jint dataBits, jint stopBit)
{
	int fd;
	int flags;
	speed_t speed;
	jobject mFileDescriptor;

	flags=0;

	/* Check arguments */
	{
		speed = getBaudrate(baudrate);
		if (speed == -1) {
		    throwException(env, "java/lang/IllegalArgumentException", "Invalid baudrate");
			return NULL;
		}
		if (parity <0 || parity>2) {
		    throwException(env, "java/lang/IllegalArgumentException", "Invalid parity");
        	return NULL;
		}
        if (dataBits <5 || dataBits>8) {
		    throwException(env, "java/lang/IllegalArgumentException", "Invalid dataBits");
            return NULL;
        }
        if (stopBit <1 || stopBit>2) {
		    throwException(env, "java/lang/IllegalArgumentException", "Invalid stopBit");
            return NULL;
        }
	}

	/* Opening device */
	{
		jboolean iscopy;
		const char *path_utf = (*env)->GetStringUTFChars(env, path, &iscopy);
		fd = open(path_utf, O_RDWR | flags);
		(*env)->ReleaseStringUTFChars(env, path, path_utf);
		if (fd == -1)
		{
		    throwException(env, "java/io/IOException", "Cannot open port");
			return NULL;
		}
	}

	/* Configure device */
	{
		struct termios cfg;
		if (tcgetattr(fd, &cfg))
		{
			close(fd);
		    throwException(env, "java/io/IOException", "tcgetattr() failed");
			return NULL;
		}

		cfmakeraw(&cfg);
		cfsetispeed(&cfg, speed);
		cfsetospeed(&cfg, speed);

		/* More attribute set */
		switch (parity) {
		    case 0: break;
		    case 1: cfg.c_cflag |= PARENB; break;
		    case 2: cfg.c_cflag &= ~PARODD; break;
		}
		switch (dataBits) {
		    case 5: cfg.c_cflag |= CS5; break;
		    case 6: cfg.c_cflag |= CS6; break;
		    case 7: cfg.c_cflag |= CS7; break;
		    case 8: cfg.c_cflag |= CS8; break;
		}
		switch (stopBit) {
		    case 1: cfg.c_cflag &= ~CSTOPB; break;
		    case 2: cfg.c_cflag |= CSTOPB; break;
		}
        int rc = tcsetattr(fd, TCSANOW, &cfg);
        /*
		if (rc)
		{
			close(fd);

		    throwException(env, "java/io/IOException", strcat("tcsetattr() failed: ", rc));
			return NULL;
		}
		*/
	}

	/* Create a corresponding file descriptor */
	{
		jclass cFileDescriptor = (*env)->FindClass(env, "java/io/FileDescriptor");
		jmethodID iFileDescriptor = (*env)->GetMethodID(env, cFileDescriptor, "<init>", "()V");
		jfieldID descriptorID = (*env)->GetFieldID(env, cFileDescriptor, "descriptor", "I");
		mFileDescriptor = (*env)->NewObject(env, cFileDescriptor, iFileDescriptor);
		(*env)->SetIntField(env, mFileDescriptor, descriptorID, (jint)fd);
	}

	return mFileDescriptor;
}

/*
 * Class:     cedric_serial_SerialPort
 * Method:    close
 * Signature: ()V
 */
JNIEXPORT void JNICALL Java_android_1serialport_1api_SerialPort_close
  (JNIEnv *env, jobject thiz)
{
	jclass SerialPortClass = (*env)->GetObjectClass(env, thiz);
	jclass FileDescriptorClass = (*env)->FindClass(env, "java/io/FileDescriptor");

	jfieldID mFdID = (*env)->GetFieldID(env, SerialPortClass, "mFd", "Ljava/io/FileDescriptor;");
	jfieldID descriptorID = (*env)->GetFieldID(env, FileDescriptorClass, "descriptor", "I");

	jobject mFd = (*env)->GetObjectField(env, thiz, mFdID);
	jint descriptor = (*env)->GetIntField(env, mFd, descriptorID);

	close(descriptor);
}

相信大家一下就能看出，相关的改动就那么一点儿（主要是以我的水平也就这样了）。

简单说一下我的改动：

1) 修改SerialPort.c里的Java_android_1serialport_1api_SerialPort_open函数，去掉了flags参数，增加了parity,dataBits,stopBit这三个参数。

    去掉了flags参数，原因是：我觉得这个参数应该总是取默认值0，因此就不用传了（不知道我的理解对不对）;

    添加了三个参数，并修改函数体，处理了这三个传入数值：

		/* More attribute set */
		switch (parity) {
		    case 0:
		        cfg.c_cflag &= ~PARENB;
		        cfg.c_cflag &= ~INPCK;
		        break;
		    case 1:
		        cfg.c_cflag |= PARENB;
		        cfg.c_cflag |= PARODD;
		        cfg.c_cflag |= INPCK;
		        break;
		    case 2:
		        cfg.c_cflag |= PARENB;
		        cfg.c_cflag &= ~PARODD;
		        cfg.c_cflag |= INPCK;
		        break;
		}

		cfg.c_cflag &= ~CSIZE;
		switch (dataBits) {
		    case 5: cfg.c_cflag |= CS5; break;
		    case 6: cfg.c_cflag |= CS6; break;
		    case 7: cfg.c_cflag |= CS7; break;
		    case 8: cfg.c_cflag |= CS8; break;
		}

		switch (stopBit) {
		    case 1: cfg.c_cflag &= ~CSTOPB; break;
		    case 2: cfg.c_cflag |= CSTOPB; break;
		}

		tcsetattr(fd, TCSANOW, &cfg);

2) 修改了SerialPort.java的入口函数:

public SerialPort(File device, int baudrate, int parity, int dataBits, int stopBit) throws SecurityException, IOException

jni调用函数：

private native static FileDescriptor open(String path, int baudrate, int parity, int dataBits, int stopBit);

以及相关的jni函数调用：

mFd = open(device.getAbsolutePath(), baudrate, parity, dataBits, stopBit);

 

然后呢，就没有任何改动了，集成方法、配置方法、部署方法也跟原版类库完全一样。

经过项目的实际测试，完全满足了需求。

实力有限，若有不足，请多提意见。