X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fcommon%2Fserial.c;h=66d8b9252a605a043abc6e232b2b9776d8dfc9a1;hb=c9bc57b6bc0c13d7bf4fef60db3030f88eeebda5;hp=6591ec89527fe45d0210bae85cfe74523ad35793;hpb=71caaad46bf285681d4921db796b81746324ff29;p=libsigrok.git

diff --git a/hardware/common/serial.c b/hardware/common/serial.c
index 6591ec89..66d8b925 100644
--- a/hardware/common/serial.c
+++ b/hardware/common/serial.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
@@ -20,43 +20,27 @@
  */
 
 #include <string.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <unistd.h>
-#ifdef _WIN32
-#include <windows.h>
-#else
-#include <glob.h>
-#include <termios.h>
-#endif
 #include <stdlib.h>
-#include <errno.h>
-#include <sys/ioctl.h>
 #include <glib.h>
+#include <serialport.h>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "serial: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
-
-// FIXME: Must be moved, or rather passed as function argument.
-#ifdef _WIN32
-static HANDLE hdl;
-#endif
+/* Message logging helpers with subsystem-specific prefix string. */
+#define LOG_PREFIX "serial: "
+#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
+#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
+#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
+#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
+#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
 
 /**
  * Open the specified serial port.
  *
  * @param serial Previously initialized serial port structure.
- * @param flags Flags to use when opening the serial port.
- * TODO: Abstract 'flags', currently they're OS-specific!
+ * @param flags Flags to use when opening the serial port. Possible flags
+ *              include SERIAL_RDWR, SERIAL_RDONLY, SERIAL_NONBLOCK.
  *
  * If the serial structure contains a serialcomm string, it will be
  * passed to serial_set_paramstr() after the port is opened.
@@ -65,6 +49,8 @@ static HANDLE hdl;
  */
 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 {
+	int ret;
+	char *error;
 
 	if (!serial) {
 		sr_dbg("Invalid serial port.");
@@ -73,20 +59,24 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 
 	sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
 
-#ifdef _WIN32
-	hdl = CreateFile(serial->port, GENERIC_READ | GENERIC_WRITE, 0, 0,
-			 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
-	if (hdl == INVALID_HANDLE_VALUE) {
-		sr_err("Error opening serial port '%s'.", serial->port);
-		return SR_ERR;
+	sp_get_port_by_name(serial->port, &serial->data);
+
+	ret = sp_open(serial->data, flags);
+
+	switch (ret)
+	{
+		case SP_ERR_ARG:
+			sr_err("Attempt to open serial port with invalid parameters.");
+			return SR_ERR_ARG;
+		case SP_ERR_FAIL:
+			error = sp_last_error_message();
+			sr_err("Error opening port: %s.", error);
+			sp_free_error_message(error);
+			return SR_ERR;
 	}
-#else
-	if ((serial->fd = open(serial->port, flags)) < 0) {
-		sr_err("Error opening serial port '%s': %s.", serial->port,
-		       strerror(errno));
-		return SR_ERR;
-	} else
-		sr_spew("Opened serial port '%s' (fd %d).", serial->port, serial->fd);
+
+#ifndef _WIN32
+	serial->fd = serial->data->fd;
 #endif
 
 	if (serial->serialcomm)
@@ -105,6 +95,7 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 {
 	int ret;
+	char *error;
 
 	if (!serial) {
 		sr_dbg("Invalid serial port.");
@@ -120,18 +111,19 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 	sr_spew("Closing serial port %s (fd %d).", serial->port, serial->fd);
 	ret = SR_OK;
 
-#ifdef _WIN32
-	/* Returns non-zero upon success, 0 upon failure. */
-	if (CloseHandle(hdl) == 0)
-		ret = SR_ERR;
-#else
-	/* Returns 0 upon success, -1 upon failure. */
-	if (close(serial->fd) < 0) {
-		sr_err("Error closing serial port: %s (fd %d).", strerror(errno),
-				serial->fd);
-		ret = SR_ERR;
+	ret = sp_close(serial->data);
+
+	switch (ret)
+	{
+		case SP_ERR_ARG:
+			sr_err("Attempt to close an invalid serial port.");
+			return SR_ERR_ARG;
+		case SP_ERR_FAIL:
+			error = sp_last_error_message();
+			sr_err("Error closing port: %s.", error);
+			sp_free_error_message(error);
+			return SR_ERR;
 	}
-#endif
 
 	serial->fd = -1;
 
@@ -148,6 +140,7 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 {
 	int ret;
+	char *error;
 
 	if (!serial) {
 		sr_dbg("Invalid serial port.");
@@ -161,23 +154,22 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 	}
 
 	sr_spew("Flushing serial port %s (fd %d).", serial->port, serial->fd);
-	ret = SR_OK;
 
-#ifdef _WIN32
-	/* Returns non-zero upon success, 0 upon failure. */
-	if (PurgeComm(hdl, PURGE_RXCLEAR | PURGE_TXCLEAR) == 0) {
-		sr_err("Error flushing serial port: %s.", strerror(errno));
-		ret = SR_ERR;
-	}
-#else
-	/* Returns 0 upon success, -1 upon failure. */
-	if (tcflush(serial->fd, TCIOFLUSH) < 0) {
-		sr_err("Error flushing serial port: %s.", strerror(errno));
-		ret = SR_ERR;
+	ret = sp_flush(serial->data);
+
+	switch (ret)
+	{
+		case SP_ERR_ARG:
+			sr_err("Attempt to flush an invalid serial port.");
+			return SR_ERR_ARG;
+		case SP_ERR_FAIL:
+			error = sp_last_error_message();
+			sr_err("Error flushing port: %s.", error);
+			sp_free_error_message(error);
+			return SR_ERR;
 	}
 
 	return ret;
-#endif
 }
 
 /**
@@ -193,6 +185,7 @@ SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 		const void *buf, size_t count)
 {
 	ssize_t ret;
+	char *error;
 
 	if (!serial) {
 		sr_dbg("Invalid serial port.");
@@ -205,20 +198,21 @@ SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 		return -1;
 	}
 
-#ifdef _WIN32
-	DWORD tmp = 0;
-
-	/* FIXME */
-	/* Returns non-zero upon success, 0 upon failure. */
-	WriteFile(hdl, buf, count, &tmp, NULL);
-#else
-	/* Returns the number of bytes written, or -1 upon failure. */
-	ret = write(serial->fd, buf, count);
-	if (ret < 0)
-		sr_err("Write error: %s.", strerror(errno));
-	else
-		sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd);
-#endif
+	ret = sp_write(serial->data, buf, count);
+
+	switch (ret)
+	{
+		case SP_ERR_ARG:
+			sr_err("Attempted serial port write with invalid arguments.");
+			return SR_ERR_ARG;
+		case SP_ERR_FAIL:
+			error = sp_last_error_message();
+			sr_err("Write error: %s.", error);
+			sp_free_error_message(error);
+			return SR_ERR;
+	}
+
+	sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd);
 
 	return ret;
 }
@@ -236,6 +230,7 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 		size_t count)
 {
 	ssize_t ret;
+	char *error;
 
 	if (!serial) {
 		sr_dbg("Invalid serial port.");
@@ -248,24 +243,21 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 		return -1;
 	}
 
-#ifdef _WIN32
-	DWORD tmp = 0;
-
-	/* FIXME */
-	/* Returns non-zero upon success, 0 upon failure. */
-	return ReadFile(hdl, buf, count, &tmp, NULL);
-#else
-	/* Returns the number of bytes read, or -1 upon failure. */
-	ret = read(serial->fd, buf, count);
-	if (ret < 0)
-		/*
- 		 * Should be sr_err(), but that would yield lots of
-		 * "Resource temporarily unavailable" messages.
-		 */
-		sr_spew("Read error: %s (fd %d).", strerror(errno), serial->fd);
-	else
-		sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
-#endif
+	ret = sp_read(serial->data, buf, count);
+
+	switch (ret)
+	{
+		case SP_ERR_ARG:
+			sr_err("Attempted serial port read with invalid arguments.");
+			return SR_ERR_ARG;
+		case SP_ERR_FAIL:
+			error = sp_last_error_message();
+			sr_err("Read error: %s.", error);
+			sp_free_error_message(error);
+			return SR_ERR;
+	}
+
+	sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
 
 	return ret;
 }
@@ -284,8 +276,12 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
  * @return SR_OK upon success, SR_ERR upon failure.
  */
 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
-		int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr)
+			      int bits, int parity, int stopbits,
+			      int flowcontrol, int rts, int dtr)
 {
+	int ret;
+	char *error;
+
 	if (!serial) {
 		sr_dbg("Invalid serial port.");
 		return SR_ERR;
@@ -293,241 +289,28 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 
 	if (serial->fd == -1) {
 		sr_dbg("Cannot configure unopened serial port %s (fd %d).",
-				serial->port, serial->fd);
+		       serial->port, serial->fd);
 		return SR_ERR;
 	}
 
 	sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
-			serial->fd);
-
-#ifdef _WIN32
-	DCB dcb;
-
-	if (!GetCommState(hdl, &dcb))
-		return SR_ERR;
-
-	switch (baudrate) {
-	case 115200:
-		dcb.BaudRate = CBR_115200;
-		break;
-	case 57600:
-		dcb.BaudRate = CBR_57600;
-		break;
-	case 38400:
-		dcb.BaudRate = CBR_38400;
-		break;
-	case 19200:
-		dcb.BaudRate = CBR_19200;
-		break;
-	case 9600:
-		dcb.BaudRate = CBR_9600;
-		break;
-	case 4800:
-		dcb.BaudRate = CBR_4800;
-		break;
-	case 2400:
-		dcb.BaudRate = CBR_2400;
-		break;
-	default:
-		sr_err("Unsupported baudrate %d.", baudrate);
-		return SR_ERR;
-	}
-	dcb.ByteSize = bits;
-	dcb.Parity = NOPARITY; /* TODO: Don't hardcode. */
-	dcb.StopBits = ONESTOPBIT; /* TODO: Don't hardcode. */
-
-	if (!SetCommState(hdl, &dcb))
-		return SR_ERR;
-#else
-	struct termios term;
-	speed_t baud;
-	int ret, controlbits;
-
-	if (tcgetattr(serial->fd, &term) < 0) {
-		sr_err("tcgetattr() error on port %s (fd %d): %s.",
-				serial->port, serial->fd, strerror(errno));
-		return SR_ERR;
-	}
-
-	switch (baudrate) {
-	case 50:
-		baud = B50;
-		break;
-	case 75:
-		baud = B75;
-		break;
-	case 110:
-		baud = B110;
-		break;
-	case 134:
-		baud = B134;
-		break;
-	case 150:
-		baud = B150;
-		break;
-	case 200:
-		baud = B200;
-		break;
-	case 300:
-		baud = B300;
-		break;
-	case 600:
-		baud = B600;
-		break;
-	case 1200:
-		baud = B1200;
-		break;
-	case 1800:
-		baud = B1800;
-		break;
-	case 2400:
-		baud = B2400;
-		break;
-	case 4800:
-		baud = B4800;
-		break;
-	case 9600:
-		baud = B9600;
-		break;
-	case 19200:
-		baud = B19200;
-		break;
-	case 38400:
-		baud = B38400;
-		break;
-	case 57600:
-		baud = B57600;
-		break;
-	case 115200:
-		baud = B115200;
-		break;
-	case 230400:
-		baud = B230400;
-		break;
-#ifndef __APPLE__
-	case 460800:
-		baud = B460800;
-		break;
-#endif
-	default:
-		sr_err("Unsupported baudrate %d.", baudrate);
-		return SR_ERR;
-	}
-
-	sr_spew("Configuring output baudrate to %d (%d).", baudrate, baud);
-	if (cfsetospeed(&term, baud) < 0) {
-		sr_err("cfsetospeed() error: %s.", strerror(errno));
-		return SR_ERR;
-	}
-
-	sr_spew("Configuring input baudrate to %d (%d).", baudrate, baud);
-	if (cfsetispeed(&term, baud) < 0) {
-		sr_err("cfsetispeed() error: %s.", strerror(errno));
-		return SR_ERR;
-	}
-
-	sr_spew("Configuring %d data bits.", bits);
-	term.c_cflag &= ~CSIZE;
-	switch (bits) {
-	case 8:
-		term.c_cflag |= CS8;
-		break;
-	case 7:
-		term.c_cflag |= CS7;
-		break;
-	default:
-		sr_err("Unsupported data bits number %d.", bits);
-		return SR_ERR;
-	}
-
-	sr_spew("Configuring %d stop bits.", stopbits);
-	term.c_cflag &= ~CSTOPB;
-	switch (stopbits) {
-	case 1:
-		term.c_cflag &= ~CSTOPB;
-		break;
-	case 2:
-		term.c_cflag |= CSTOPB;
-		break;
-	default:
-		sr_err("Unsupported stopbits number %d.", stopbits);
-		return SR_ERR;
-	}
-
-	term.c_iflag &= ~(IXON | IXOFF);
-	term.c_cflag &= ~CRTSCTS;
-	switch (flowcontrol) {
-	case 0:
-		/* No flow control. */
-		sr_spew("Configuring no flow control.");
-		break;
-	case 1:
-		sr_spew("Configuring RTS/CTS flow control.");
-		term.c_cflag |= CRTSCTS;
-		break;
-	case 2:
-		sr_spew("Configuring XON/XOFF flow control.");
-		term.c_iflag |= IXON | IXOFF;
-		break;
-	default:
-		sr_err("Unsupported flow control setting %d.", flowcontrol);
-		return SR_ERR;
-	}
-
-	term.c_iflag &= ~IGNPAR;
-	term.c_cflag &= ~(PARODD | PARENB);
-	switch (parity) {
-	case SERIAL_PARITY_NONE:
-		sr_spew("Configuring no parity.");
-		term.c_iflag |= IGNPAR;
-		break;
-	case SERIAL_PARITY_EVEN:
-		sr_spew("Configuring even parity.");
-		term.c_cflag |= PARENB;
-		break;
-	case SERIAL_PARITY_ODD:
-		sr_spew("Configuring odd parity.");
-		term.c_cflag |= PARENB | PARODD;
-		break;
-	default:
-		sr_err("Unsupported parity setting %d.", parity);
-		return SR_ERR;
-	}
-
-	/* Do not translate carriage return to newline on input. */
-	term.c_iflag &= ~(ICRNL);
-
-	/* Disable canonical mode, and don't echo input characters. */
-	term.c_lflag &= ~(ICANON | ECHO);
-
-	/* Write the configured settings. */
-	if (tcsetattr(serial->fd, TCSADRAIN, &term) < 0) {
-		sr_err("tcsetattr() error: %s.", strerror(errno));
-		return SR_ERR;
-	}
-
-	if (rts != -1) {
-		sr_spew("Setting RTS %s.", rts ? "high" : "low");
-		controlbits = TIOCM_RTS;
-		if ((ret = ioctl(serial->fd, rts ? TIOCMBIS : TIOCMBIC,
-				&controlbits)) < 0) {
-			sr_err("Error setting RTS: %s.", strerror(errno));
-			return SR_ERR;
-		}
-	}
-
-	if (dtr != -1) {
-		sr_spew("Setting DTR %s.", dtr ? "high" : "low");
-		controlbits = TIOCM_DTR;
-		if ((ret = ioctl(serial->fd, dtr ? TIOCMBIS : TIOCMBIC,
-				&controlbits)) < 0) {
-			sr_err("Error setting DTR: %s.", strerror(errno));
+		serial->fd);
+
+	ret = sp_set_params(serial->data, baudrate, bits, parity, stopbits,
+			flowcontrol, rts, dtr);
+
+	switch (ret)
+	{
+		case SP_ERR_ARG:
+			sr_err("Invalid arguments for setting serial port parameters.");
+			return SR_ERR_ARG;
+		case SP_ERR_FAIL:
+			error = sp_last_error_message();
+			sr_err("Error setting serial port parameters: %s.", error);
+			sp_free_error_message(error);
 			return SR_ERR;
-		}
 	}
 
-#endif
-
 	return SR_OK;
 }
 
@@ -536,8 +319,8 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
  *
  * @param serial Previously initialized serial port structure.
  * @param paramstr A serial communication parameters string, in the form
- * of <speed>/<data bits><parity><stopbits>, for example "9600/8n1" or
- * "600/7o2".
+ * of <speed>/<data bits><parity><stopbits><flow>, for example "9600/8n1" or
+ * "600/7o2" or "460800/8n1/flow=2" where flow is 0 for none, 1 for rts/cts and 2 for xon/xoff.
  *
  * @return SR_OK upon success, SR_ERR upon failure.
  */
@@ -547,11 +330,12 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 {
 	GRegex *reg;
 	GMatchInfo *match;
-	int speed, databits, parity, stopbits, rts, dtr, i;
+	int speed, databits, parity, stopbits, flow, rts, dtr, i;
 	char *mstr, **opts, **kv;
 
-	speed = databits = parity = stopbits = 0;
+	speed = databits = parity = stopbits = flow = 0;
 	rts = dtr = -1;
+	sr_spew("Parsing parameters from \"%s\".", paramstr);
 	reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
 	if (g_regex_match(reg, paramstr, 0, &match)) {
 		if ((mstr = g_match_info_fetch(match, 1)))
@@ -604,6 +388,17 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 							sr_dbg("invalid value for dtr: %c", kv[1][0]);
 							speed = 0;
 						}
+					} else if (!strncmp(kv[0], "flow", 4)) {
+						if (kv[1][0] == '0')
+							flow = 0;
+						else if (kv[1][0] == '1')
+							flow = 1;
+						else if (kv[1][0] == '2')
+							flow = 2;
+						else {
+							sr_dbg("invalid value for flow: %c", kv[1][0]);
+							speed = 0;
+						}
 					}
 					g_strfreev(kv);
 				}
@@ -615,11 +410,13 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 	g_match_info_unref(match);
 	g_regex_unref(reg);
 
-	if (speed)
-		return serial_set_params(serial, speed, databits, parity, stopbits,
-				0, rts, dtr);
-	else
+	if (speed) {
+		return serial_set_params(serial, speed, databits, parity,
+					 stopbits, flow, rts, dtr);
+	} else {
+		sr_dbg("Could not infer speed from parameter string.");
 		return SR_ERR_ARG;
+	}
 }
 
 /**
@@ -674,7 +471,8 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 		if (g_get_monotonic_time() - start > timeout_ms)
 			/* Timeout */
 			break;
-		g_usleep(2000);
+		if (len < 1)
+			g_usleep(2000);
 	}
 	if (*buflen)
 		sr_dbg("Received %d: '%s'.", *buflen, *buf);
@@ -728,7 +526,7 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 		if (len > 0) {
 			ibuf += len;
 		} else if (len == 0) {
-			sr_spew("Error: Only read 0 bytes.");
+			/* No logging, already done in serial_read(). */
 		} else {
 			/* Error reading byte, but continuing anyway. */
 		}
@@ -755,7 +553,8 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 			sr_dbg("Detection timed out after %dms.", time);
 			break;
 		}
-		g_usleep(byte_delay_us);
+		if (len < 1)
+			g_usleep(byte_delay_us);
 	}
 
 	*buflen = ibuf;