X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fcommon%2Fserial.c;h=a267d6fb88367fa246c3c739a697b218e110a0dc;hb=17bdda58686a208424520b64f9324eba259ff535;hp=781edc19fc9d37e4af396b137a3b07b8c6a856fa;hpb=a0a4c0fb09cac1105ad03325d7232a8f492f181c;p=libsigrok.git

diff --git a/hardware/common/serial.c b/hardware/common/serial.c
index 781edc19..a267d6fb 100644
--- a/hardware/common/serial.c
+++ b/hardware/common/serial.c
@@ -26,14 +26,7 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* 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)
+#define LOG_PREFIX "serial"
 
 /**
  * Open the specified serial port.
@@ -77,15 +70,12 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 		return SR_ERR_ARG;
 	case SP_ERR_FAIL:
 		error = sp_last_error_message();
-		sr_err("Error opening port: %s.", error);
+		sr_err("Error opening port (%d): %s.",
+			sp_last_error_code(), error);
 		sp_free_error_message(error);
 		return SR_ERR;
 	}
 
-#ifndef _WIN32
-	sp_get_port_handle(serial->data, &serial->fd);
-#endif
-
 	if (serial->serialcomm)
 		return serial_set_paramstr(serial, serial->serialcomm);
 	else
@@ -109,16 +99,14 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 		return SR_ERR;
 	}
 
-	if (serial->fd == -1) {
-		sr_dbg("Cannot close unopened serial port %s (fd %d).",
-				serial->port, serial->fd);
+	if (!serial->data) {
+		sr_dbg("Cannot close unopened serial port %s.", serial->port);
 		return SR_ERR;
 	}
 
-	sr_spew("Closing serial port %s (fd %d).", serial->port, serial->fd);
+	sr_spew("Closing serial port %s.", serial->port);
 
 	ret = sp_close(serial->data);
-	sp_free_port(serial->data);
 
 	switch (ret) {
 	case SP_ERR_ARG:
@@ -126,12 +114,14 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 		return SR_ERR_ARG;
 	case SP_ERR_FAIL:
 		error = sp_last_error_message();
-		sr_err("Error closing port: %s.", error);
+		sr_err("Error closing port (%d): %s.",
+			sp_last_error_code(), error);
 		sp_free_error_message(error);
 		return SR_ERR;
 	}
 
-	serial->fd = -1;
+	sp_free_port(serial->data);
+	serial->data = NULL;
 
 	return SR_OK;
 }
@@ -153,13 +143,12 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 		return SR_ERR;
 	}
 
-	if (serial->fd == -1) {
-		sr_dbg("Cannot flush unopened serial port %s (fd %d).",
-				serial->port, serial->fd);
+	if (!serial->data) {
+		sr_dbg("Cannot flush unopened serial port %s.", serial->port);
 		return SR_ERR;
 	}
 
-	sr_spew("Flushing serial port %s (fd %d).", serial->port, serial->fd);
+	sr_spew("Flushing serial port %s.", serial->port);
 
 	ret = sp_flush(serial->data, SP_BUF_BOTH);
 
@@ -169,7 +158,8 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 		return SR_ERR_ARG;
 	case SP_ERR_FAIL:
 		error = sp_last_error_message();
-		sr_err("Error flushing port: %s.", error);
+		sr_err("Error flushing port (%d): %s.",
+			sp_last_error_code(), error);
 		sp_free_error_message(error);
 		return SR_ERR;
 	}
@@ -177,17 +167,8 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 	return SR_OK;
 }
 
-/**
- * Write a number of bytes to the specified serial port.
- *
- * @param serial Previously initialized serial port structure.
- * @param buf Buffer containing the bytes to write.
- * @param count Number of bytes to write.
- *
- * @return The number of bytes written, or a negative error code upon failure.
- */
-SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
-		const void *buf, size_t count)
+static int _serial_write(struct sr_serial_dev_inst *serial,
+		const void *buf, size_t count, int nonblocking)
 {
 	ssize_t ret;
 	char *error;
@@ -197,13 +178,12 @@ SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 		return SR_ERR;
 	}
 
-	if (serial->fd == -1) {
-		sr_dbg("Cannot use unopened serial port %s (fd %d).",
-				serial->port, serial->fd);
+	if (!serial->data) {
+		sr_dbg("Cannot use unopened serial port %s.", serial->port);
 		return SR_ERR;
 	}
 
-	if (serial->nonblocking)
+	if (nonblocking)
 		ret = sp_nonblocking_write(serial->data, buf, count);
 	else
 		ret = sp_blocking_write(serial->data, buf, count, 0);
@@ -214,27 +194,45 @@ SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 		return SR_ERR_ARG;
 	case SP_ERR_FAIL:
 		error = sp_last_error_message();
-		sr_err("Write error: %s.", error);
+		sr_err("Write error (%d): %s.", sp_last_error_code(), error);
 		sp_free_error_message(error);
 		return SR_ERR;
 	}
 
-	sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd);
+	sr_spew("Wrote %d/%d bytes.", ret, count);
 
 	return ret;
 }
 
 /**
- * Read a number of bytes from the specified serial port.
+ * Write a number of bytes to the specified serial port.
  *
  * @param serial Previously initialized serial port structure.
- * @param buf Buffer where to store the bytes that are read.
- * @param count The number of bytes to read.
+ * @param buf Buffer containing the bytes to write.
+ * @param count Number of bytes to write.
  *
- * @return The number of bytes read, or a negative error code upon failure.
+ * @return The number of bytes written, or a negative error code upon failure.
  */
-SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
-		size_t count)
+SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
+		const void *buf, size_t count)
+{
+	return _serial_write(serial, buf, count, serial->nonblocking);
+}
+
+SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
+		const void *buf, size_t count)
+{
+	return _serial_write(serial, buf, count, 0);
+}
+
+SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
+		const void *buf, size_t count)
+{
+	return _serial_write(serial, buf, count, 1);
+}
+
+static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
+		size_t count, int nonblocking)
 {
 	ssize_t ret;
 	char *error;
@@ -244,13 +242,12 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 		return SR_ERR;
 	}
 
-	if (serial->fd == -1) {
-		sr_dbg("Cannot use unopened serial port %s (fd %d).",
-				serial->port, serial->fd);
+	if (!serial->data) {
+		sr_dbg("Cannot use unopened serial port %s.", serial->port);
 		return SR_ERR;
 	}
 
-	if (serial->nonblocking)
+	if (nonblocking)
 		ret = sp_nonblocking_read(serial->data, buf, count);
 	else
 		ret = sp_blocking_read(serial->data, buf, count, 0);
@@ -261,29 +258,59 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 		return SR_ERR_ARG;
 	case SP_ERR_FAIL:
 		error = sp_last_error_message();
-		sr_err("Read error: %s.", error);
+		sr_err("Read error (%d): %s.", sp_last_error_code(), error);
 		sp_free_error_message(error);
 		return SR_ERR;
 	}
 
 	if (ret > 0)
-		sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
+		sr_spew("Read %d/%d bytes.", ret, count);
 
 	return ret;
 }
 
+/**
+ * Read a number of bytes from the specified serial port.
+ *
+ * @param serial Previously initialized serial port structure.
+ * @param buf Buffer where to store the bytes that are read.
+ * @param count The number of bytes to read.
+ *
+ * @return The number of bytes read, or a negative error code upon failure.
+ */
+SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
+		size_t count)
+{
+	return _serial_read(serial, buf, count, serial->nonblocking);
+}
+
+SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
+		size_t count)
+{
+	return _serial_read(serial, buf, count, 0);
+}
+
+SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
+		size_t count)
+{
+	return _serial_read(serial, buf, count, 1);
+}
+
 /**
  * Set serial parameters for the specified serial port.
  *
  * @param serial Previously initialized serial port structure.
- * @param baudrate The baudrate to set.
- * @param bits The number of data bits to use.
- * @param parity The parity setting to use (0 = none, 1 = even, 2 = odd).
- * @param stopbits The number of stop bits to use (1 or 2).
- * @param flowcontrol The flow control settings to use (0 = none, 1 = RTS/CTS,
- *                    2 = XON/XOFF).
+ * @param[in] baudrate The baudrate to set.
+ * @param[in] bits The number of data bits to use (5, 6, 7 or 8).
+ * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd).
+ * @param[in] stopbits The number of stop bits to use (1 or 2).
+ * @param[in] flowcontrol The flow control settings to use (0 = none,
+ *                      1 = RTS/CTS, 2 = XON/XOFF).
+ * @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
+ * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
  *
- * @return SR_OK upon success, SR_ERR upon failure.
+ * @retval SR_OK Success
+ * @retval SR_ERR Failure.
  */
 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 			      int bits, int parity, int stopbits,
@@ -298,14 +325,12 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 		return SR_ERR;
 	}
 
-	if (serial->fd == -1) {
-		sr_dbg("Cannot configure unopened serial port %s (fd %d).",
-		       serial->port, serial->fd);
+	if (!serial->data) {
+		sr_dbg("Cannot configure unopened serial port %s.", serial->port);
 		return SR_ERR;
 	}
 
-	sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
-		serial->fd);
+	sr_spew("Setting serial parameters on port %s.", serial->port);
 
 	sp_new_config(&config);
 	sp_set_config_baudrate(config, baudrate);
@@ -339,7 +364,8 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 		return SR_ERR_ARG;
 	case SP_ERR_FAIL:
 		error = sp_last_error_message();
-		sr_err("Error setting serial port parameters: %s.", error);
+		sr_err("Error setting serial port parameters (%d): %s.",
+			sp_last_error_code(), error);
 		sp_free_error_message(error);
 		return SR_ERR;
 	}
@@ -348,19 +374,30 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 }
 
 /**
- * Set serial parameters for the specified serial port.
+ * Set serial parameters for the specified serial port from parameter string.
  *
  * @param serial Previously initialized serial port structure.
- * @param paramstr A serial communication parameters string, in the form
- * 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.
+ * @param[in] paramstr A serial communication parameters string of the form
+ * "<baudrate>/<bits><parity><stopbits>{/<option>}".\n
+ *  Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n
+ * \<baudrate\>=integer Baud rate.\n
+ * \<bits\>=5|6|7|8 Number of data bits.\n
+ * \<parity\>=n|e|o None, even, odd.\n
+ * \<stopbits\>=1|2 One or two stop bits.\n
+ * Options:\n
+ * dtr=0|1 Set DTR off resp. on.\n
+ * flow=0|1|2 Flow control. 0 for none, 1 for RTS/CTS, 2 for XON/XOFF.\n
+ * rts=0|1 Set RTS off resp. on.\n
+ * Please note that values and combinations of these parameters must be
+ * supported by the concrete serial interface hardware and the drivers for it.
+ * @retval SR_OK Success.
+ * @retval SR_ERR Failure.
  */
-#define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 		const char *paramstr)
 {
+#define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
+
 	GRegex *reg;
 	GMatchInfo *match;
 	int speed, databits, parity, stopbits, flow, rts, dtr, i;
@@ -458,11 +495,12 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
  * @param serial Previously initialized serial port structure.
  * @param buf Buffer where to store the bytes that are read.
  * @param buflen Size of the buffer.
- * @param timeout_ms How long to wait for a line to come in.
+ * @param[in] timeout_ms How long to wait for a line to come in.
  *
  * Reading stops when CR of LR is found, which is stripped from the buffer.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @retval SR_OK Success.
+ * @retval SR_ERR Failure.
  */
 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 		int *buflen, gint64 timeout_ms)
@@ -470,14 +508,13 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 	gint64 start;
 	int maxlen, len;
 
-	if (!serial || serial->fd == -1) {
+	if (!serial) {
 		sr_dbg("Invalid serial port.");
 		return SR_ERR;
 	}
 
-	if (serial->fd == -1) {
-		sr_dbg("Cannot use unopened serial port %s (fd %d).",
-				serial->port, serial->fd);
+	if (!serial->data) {
+		sr_dbg("Cannot use unopened serial port %s.", serial->port);
 		return -1;
 	}
 
@@ -518,17 +555,17 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
  *
  * @param serial Previously initialized serial port structure.
  * @param buf Buffer containing the bytes to write.
- * @param count Size of the buffer.
- * @param packet_size Size, in bytes, of a valid packet.
+ * @param buflen Size of the buffer.
+ * @param[in] packet_size Size, in bytes, of a valid packet.
  * @param is_valid Callback that assesses whether the packet is valid or not.
- * @param timeout_ms The timeout after which, if no packet is detected, to
+ * @param[in] timeout_ms The timeout after which, if no packet is detected, to
  *                   abort scanning.
- * @param baudrate The baudrate of the serial port. This parameter is not
+ * @param[in] baudrate The baudrate of the serial port. This parameter is not
  *                 critical, but it helps fine tune the serial port polling
  *                 delay.
  *
- * @return SR_OK if a valid packet is found within the given timeout,
- *         SR_ERR upon failure.
+ * @retval SR_OK Valid packet was found within the given timeout
+ * @retval SR_ERR Failure.
  */
 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 				 uint8_t *buf, size_t *buflen,
@@ -541,8 +578,8 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 
 	maxlen = *buflen;
 
-	sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64
-	       "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate);
+	sr_dbg("Detecting packets on %s (timeout = %" PRIu64
+	       "ms, baudrate = %d).", serial->port, timeout_ms, baudrate);
 
 	if (maxlen < (packet_size / 2) ) {
 		sr_err("Buffer size must be at least twice the packet size.");
@@ -639,25 +676,69 @@ SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_devic
 	return SR_OK;
 }
 
-SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
-		int timeout, sr_receive_data_callback_t cb, void *cb_data)
-{
 #ifdef _WIN32
-	return SR_ERR;
+typedef HANDLE event_handle;
 #else
-	int fd;
-	sp_get_port_handle(serial->data, &fd);
-	return sr_source_add(fd, events, timeout, cb, cb_data);
+typedef int event_handle;
 #endif
+
+SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
+		int timeout, sr_receive_data_callback_t cb, void *cb_data)
+{
+	enum sp_event mask = 0;
+	unsigned int i;
+
+	if (sp_new_event_set(&serial->event_set) != SP_OK)
+		return SR_ERR;
+
+	if (events & G_IO_IN)
+		mask |= SP_EVENT_RX_READY;
+	if (events & G_IO_OUT)
+		mask |= SP_EVENT_TX_READY;
+	if (events & G_IO_ERR)
+		mask |= SP_EVENT_ERROR;
+
+	if (sp_add_port_events(serial->event_set, serial->data, mask) != SP_OK) {
+		sp_free_event_set(serial->event_set);
+		return SR_ERR;
+	}
+
+	serial->pollfds = (GPollFD *) g_malloc0(sizeof(GPollFD) * serial->event_set->count);
+
+	for (i = 0; i < serial->event_set->count; i++) {
+
+		serial->pollfds[i].fd = ((event_handle *) serial->event_set->handles)[i];
+
+		mask = serial->event_set->masks[i];
+
+		if (mask & SP_EVENT_RX_READY)
+			serial->pollfds[i].events |= G_IO_IN;
+		if (mask & SP_EVENT_TX_READY)
+			serial->pollfds[i].events |= G_IO_OUT;
+		if (mask & SP_EVENT_ERROR)
+			serial->pollfds[i].events |= G_IO_ERR;
+
+		if (sr_session_source_add_pollfd(&serial->pollfds[i],
+				timeout, cb, cb_data) != SR_OK)
+			return SR_ERR;
+	}
+
+	return SR_OK;
 }
 
 SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial)
 {
-#ifdef _WIN32
-	return SR_ERR;
-#else
-	int fd;
-	sp_get_port_handle(serial->data, &fd);
-	return sr_source_remove(fd);
-#endif
+	unsigned int i;
+
+	for (i = 0; i < serial->event_set->count; i++)
+		if (sr_session_source_remove_pollfd(&serial->pollfds[i]) != SR_OK)
+			return SR_ERR;
+
+	g_free(serial->pollfds);
+	sp_free_event_set(serial->event_set);
+
+	serial->pollfds = NULL;
+	serial->event_set = NULL;
+
+	return SR_OK;
 }