X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=serialport.c;h=c233b28564c799b66cd3e903cd92dd45a9ea6ded;hb=89c3d63e1a36c243fa79edd8f914acd0c54f98db;hp=520d27e8531a4014e6a9746f9bd25b5d2b91103b;hpb=ae2c5825e79ab5b38a8ca53941df6d73679a52e6;p=libserialport.git

diff --git a/serialport.c b/serialport.c
index 520d27e..c233b28 100644
--- a/serialport.c
+++ b/serialport.c
@@ -55,6 +55,28 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data,
 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 	const struct sp_port_config *config);
 
+#ifndef _WIN32
+static void get_time(struct timeval *time)
+{
+#ifdef HAVE_CLOCK_GETTIME
+	struct timespec ts;
+	if (clock_gettime(CLOCK_MONOTONIC, &ts) == -1)
+		clock_gettime(CLOCK_REALTIME, &ts);
+	time->tv_sec = ts.tv_sec;
+	time->tv_usec = ts.tv_nsec / 1000;
+#elif defined(__APPLE__)
+	mach_timebase_info_data_t info;
+	mach_timebase_info(&info);
+	uint64_t ticks = mach_absolute_time();
+	uint64_t ns = (ticks * info.numer) / info.denom;
+	time->tv_sec = ns / 1000000000;
+	time->tv_usec = (ns % 1000000000) / 1000;
+#else
+	gettimeofday(time, NULL);
+#endif
+}
+#endif
+
 SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
 {
 	struct sp_port *port;
@@ -75,6 +97,20 @@ SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port *
 
 	DEBUG_FMT("Building structure for port %s", portname);
 
+#if !defined(_WIN32) && defined(HAVE_REALPATH)
+	/*
+	 * get_port_details() below tries to be too smart and figure out
+	 * some transport properties from the port name which breaks with
+	 * symlinks. Therefore we canonicalize the portname first.
+	 */
+	char pathbuf[PATH_MAX + 1];
+	char *res = realpath(portname, pathbuf);
+	if (!res)
+		RETURN_ERROR(SP_ERR_ARG, "Could not retrieve realpath behind port name");
+
+	portname = pathbuf;
+#endif
+
 	if (!(port = malloc(sizeof(struct sp_port))))
 		RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
 
@@ -90,6 +126,8 @@ SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port *
 #ifdef _WIN32
 	port->usb_path = NULL;
 	port->hdl = INVALID_HANDLE_VALUE;
+	port->write_buf = NULL;
+	port->write_buf_size = 0;
 #else
 	port->fd = -1;
 #endif
@@ -296,6 +334,8 @@ SP_API void sp_free_port(struct sp_port *port)
 #ifdef _WIN32
 	if (port->usb_path)
 		free(port->usb_path);
+	if (port->write_buf)
+		free(port->write_buf);
 #endif
 
 	free(port);
@@ -309,7 +349,8 @@ SP_PRIV struct sp_port **list_append(struct sp_port **list,
 	void *tmp;
 	unsigned int count;
 
-	for (count = 0; list[count]; count++);
+	for (count = 0; list[count]; count++)
+		;
 	if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
 		goto fail;
 	list = tmp;
@@ -389,12 +430,12 @@ SP_API void sp_free_port_list(struct sp_port **list)
 #ifdef _WIN32
 #define CHECK_PORT_HANDLE() do { \
 	if (port->hdl == INVALID_HANDLE_VALUE) \
-		RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
+		RETURN_ERROR(SP_ERR_ARG, "Port not open"); \
 } while (0)
 #else
 #define CHECK_PORT_HANDLE() do { \
 	if (port->fd < 0) \
-		RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
+		RETURN_ERROR(SP_ERR_ARG, "Port not open"); \
 } while (0)
 #endif
 #define CHECK_OPEN_PORT() do { \
@@ -522,7 +563,7 @@ SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 		RETURN_CODEVAL(ret);
 	}
 #else
-	int flags_local = O_NONBLOCK | O_NOCTTY;
+	int flags_local = O_NONBLOCK | O_NOCTTY | O_CLOEXEC;
 
 	/* Map 'flags' to the OS-specific settings. */
 	if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
@@ -628,6 +669,10 @@ SP_API enum sp_return sp_close(struct sp_port *port)
 	CLOSE_OVERLAPPED(write_ovl);
 	CLOSE_OVERLAPPED(wait_ovl);
 
+	if (port->write_buf) {
+		free(port->write_buf);
+		port->write_buf = NULL;
+	}
 #else
 	/* Returns 0 upon success, -1 upon failure. */
 	if (close(port->fd) == -1)
@@ -697,7 +742,9 @@ SP_API enum sp_return sp_drain(struct sp_port *port)
 #else
 	int result;
 	while (1) {
-#ifdef __ANDROID__
+#if defined(__ANDROID__) && (__ANDROID_API__ < 21)
+		/* Android only has tcdrain from platform 21 onwards.
+		 * On previous API versions, use the ioctl directly. */
 		int arg = 1;
 		result = ioctl(port->fd, TCSBRK, &arg);
 #else
@@ -717,6 +764,27 @@ SP_API enum sp_return sp_drain(struct sp_port *port)
 #endif
 }
 
+#ifdef _WIN32
+static enum sp_return await_write_completion(struct sp_port *port)
+{
+	TRACE("%p", port);
+	DWORD bytes_written;
+	BOOL result;
+
+	/* Wait for previous non-blocking write to complete, if any. */
+	if (port->writing) {
+		DEBUG("Waiting for previous write to complete");
+		result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
+		port->writing = 0;
+		if (!result)
+			RETURN_FAIL("Previous write failed to complete");
+		DEBUG("Previous write completed");
+	}
+
+	RETURN_OK();
+}
+#endif
+
 SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
                                         size_t count, unsigned int timeout_ms)
 {
@@ -739,17 +807,8 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
 
 #ifdef _WIN32
 	DWORD bytes_written = 0;
-	BOOL result;
 
-	/* Wait for previous non-blocking write to complete, if any. */
-	if (port->writing) {
-		DEBUG("Waiting for previous write to complete");
-		result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
-		port->writing = 0;
-		if (!result)
-			RETURN_FAIL("Previous write failed to complete");
-		DEBUG("Previous write completed");
-	}
+	TRY(await_write_completion(port));
 
 	/* Set timeout. */
 	if (port->timeouts.WriteTotalTimeoutConstant != timeout_ms) {
@@ -758,14 +817,24 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
 			RETURN_FAIL("SetCommTimeouts() failed");
 	}
 
+	/* Reduce count if it exceeds the WriteFile limit. */
+	if (count > WRITEFILE_MAX_SIZE)
+		count = WRITEFILE_MAX_SIZE;
+
 	/* Start write. */
 	if (WriteFile(port->hdl, buf, count, NULL, &port->write_ovl)) {
 		DEBUG("Write completed immediately");
 		RETURN_INT(count);
 	} else if (GetLastError() == ERROR_IO_PENDING) {
 		DEBUG("Waiting for write to complete");
-		if (GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE) == 0)
-			RETURN_FAIL("GetOverlappedResult() failed");
+		if (GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE) == 0) {
+			if (GetLastError() == ERROR_SEM_TIMEOUT) {
+				DEBUG("Write timed out");
+				RETURN_INT(0);
+			} else {
+				RETURN_FAIL("GetOverlappedResult() failed");
+			}
+		}
 		DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, count);
 		RETURN_INT(bytes_written);
 	} else {
@@ -781,7 +850,7 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
 
 	if (timeout_ms) {
 		/* Get time at start of operation. */
-		gettimeofday(&start, NULL);
+		get_time(&start);
 		/* Define duration of timeout. */
 		delta.tv_sec = timeout_ms / 1000;
 		delta.tv_usec = (timeout_ms % 1000) * 1000;
@@ -800,7 +869,7 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
 		 * select() is even run.
 		 */
 		if (timeout_ms && started) {
-			gettimeofday(&now, NULL);
+			get_time(&now);
 			if (timercmp(&now, &end, >))
 				/* Timeout has expired. */
 				break;
@@ -859,8 +928,7 @@ SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
 		RETURN_INT(0);
 
 #ifdef _WIN32
-	DWORD written = 0;
-	BYTE *ptr = (BYTE *) buf;
+	DWORD buf_bytes;
 
 	/* Check whether previous write is complete. */
 	if (port->writing) {
@@ -881,48 +949,43 @@ SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
 			RETURN_FAIL("SetCommTimeouts() failed");
 	}
 
-	/*
-	 * Keep writing data until the OS has to actually start an async IO
-	 * for it. At that point we know the buffer is full.
-	 */
-	while (written < count) {
-		/* Copy first byte of user buffer. */
-		port->pending_byte = *ptr++;
-
-		/* Start asynchronous write. */
-		if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) {
-			if (GetLastError() == ERROR_IO_PENDING) {
-				if (HasOverlappedIoCompleted(&port->write_ovl)) {
-					DEBUG("Asynchronous write completed immediately");
-					port->writing = 0;
-					written++;
-					continue;
-				} else {
-					DEBUG("Asynchronous write running");
-					port->writing = 1;
-					RETURN_INT(++written);
-				}
-			} else {
-				/* Actual failure of some kind. */
-				RETURN_FAIL("WriteFile() failed");
-			}
+	/* Reduce count if it exceeds the WriteFile limit. */
+	if (count > WRITEFILE_MAX_SIZE)
+		count = WRITEFILE_MAX_SIZE;
+
+	/* Copy data to our write buffer. */
+	buf_bytes = min(port->write_buf_size, count);
+	memcpy(port->write_buf, buf, buf_bytes);
+
+	/* Start asynchronous write. */
+	if (WriteFile(port->hdl, port->write_buf, buf_bytes, NULL, &port->write_ovl) == 0) {
+		if (GetLastError() == ERROR_IO_PENDING) {
+			if ((port->writing = !HasOverlappedIoCompleted(&port->write_ovl)))
+				DEBUG("Asynchronous write completed immediately");
+			else
+				DEBUG("Asynchronous write running");
 		} else {
-			DEBUG("Single byte written immediately");
-			written++;
+			/* Actual failure of some kind. */
+			RETURN_FAIL("WriteFile() failed");
 		}
 	}
 
 	DEBUG("All bytes written immediately");
 
-	RETURN_INT(written);
+	RETURN_INT(buf_bytes);
 #else
 	/* Returns the number of bytes written, or -1 upon failure. */
 	ssize_t written = write(port->fd, buf, count);
 
-	if (written < 0)
-		RETURN_FAIL("write() failed");
-	else
+	if (written < 0) {
+		if (errno == EAGAIN)
+			// Buffer is full, no bytes written.
+			RETURN_INT(0);
+		else
+			RETURN_FAIL("write() failed");
+	} else {
 		RETURN_INT(written);
+	}
 #endif
 }
 
@@ -999,7 +1062,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 
 #else
 	size_t bytes_read = 0;
-	unsigned char *ptr = (unsigned char *) buf;
+	unsigned char *ptr = (unsigned char *)buf;
 	struct timeval start, delta, now, end = {0, 0};
 	int started = 0;
 	fd_set fds;
@@ -1007,7 +1070,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 
 	if (timeout_ms) {
 		/* Get time at start of operation. */
-		gettimeofday(&start, NULL);
+		get_time(&start);
 		/* Define duration of timeout. */
 		delta.tv_sec = timeout_ms / 1000;
 		delta.tv_usec = (timeout_ms % 1000) * 1000;
@@ -1026,7 +1089,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 		 * select() is even run.
 		 */
 		if (timeout_ms && started) {
-			gettimeofday(&now, NULL);
+			get_time(&now);
 			if (timercmp(&now, &end, >))
 				/* Timeout has expired. */
 				break;
@@ -1112,9 +1175,8 @@ SP_API enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf,
 	/* Loop until we have at least one byte, or timeout is reached. */
 	while (bytes_read == 0) {
 		/* Start read. */
-		if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl)) {
+		if (ReadFile(port->hdl, buf, count, &bytes_read, &port->read_ovl)) {
 			DEBUG("Read completed immediately");
-			bytes_read = count;
 		} else if (GetLastError() == ERROR_IO_PENDING) {
 			DEBUG("Waiting for read to complete");
 			if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
@@ -1145,7 +1207,7 @@ SP_API enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf,
 
 	if (timeout_ms) {
 		/* Get time at start of operation. */
-		gettimeofday(&start, NULL);
+		get_time(&start);
 		/* Define duration of timeout. */
 		delta.tv_sec = timeout_ms / 1000;
 		delta.tv_usec = (timeout_ms % 1000) * 1000;
@@ -1164,7 +1226,7 @@ SP_API enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf,
 		 * select() is even run.
 		 */
 		if (timeout_ms && started) {
-			gettimeofday(&now, NULL);
+			get_time(&now);
 			if (timercmp(&now, &end, >))
 				/* Timeout has expired. */
 				break;
@@ -1423,7 +1485,8 @@ SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
 #else
 	struct timeval start, delta, now, end = {0, 0};
 	const struct timeval max_delta = {
-		(INT_MAX / 1000), (INT_MAX % 1000) * 1000};
+		(INT_MAX / 1000), (INT_MAX % 1000) * 1000
+	};
 	int started = 0, timeout_overflow = 0;
 	int result, timeout_remaining_ms;
 	struct pollfd *pollfds;
@@ -1433,7 +1496,7 @@ SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
 		RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
 
 	for (i = 0; i < event_set->count; i++) {
-		pollfds[i].fd = ((int *) event_set->handles)[i];
+		pollfds[i].fd = ((int *)event_set->handles)[i];
 		pollfds[i].events = 0;
 		pollfds[i].revents = 0;
 		if (event_set->masks[i] & SP_EVENT_RX_READY)
@@ -1446,7 +1509,7 @@ SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
 
 	if (timeout_ms) {
 		/* Get time at start of operation. */
-		gettimeofday(&start, NULL);
+		get_time(&start);
 		/* Define duration of timeout. */
 		delta.tv_sec = timeout_ms / 1000;
 		delta.tv_usec = (timeout_ms % 1000) * 1000;
@@ -1467,7 +1530,7 @@ SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
 			timeout_overflow = (timeout_ms > INT_MAX);
 			timeout_remaining_ms = timeout_overflow ? INT_MAX : timeout_ms;
 		} else {
-			gettimeofday(&now, NULL);
+			get_time(&now);
 			if (timercmp(&now, &end, >)) {
 				DEBUG("Wait timed out");
 				break;
@@ -1843,6 +1906,9 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 	DEBUG_FMT("Setting configuration for port %s", port->name);
 
 #ifdef _WIN32
+
+	TRY(await_write_completion(port));
+
 	if (config->baudrate >= 0) {
 		for (i = 0; i < NUM_STD_BAUDRATES; i++) {
 			if (config->baudrate == std_baudrates[i].value) {
@@ -1853,6 +1919,14 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 
 		if (i == NUM_STD_BAUDRATES)
 			data->dcb.BaudRate = config->baudrate;
+
+		/* Allocate write buffer for 50ms of data at baud rate. */
+		port->write_buf_size = max(config->baudrate / (8 * 20), 1);
+		port->write_buf = realloc(port->write_buf,
+					  port->write_buf_size);
+
+		if (!port->write_buf)
+			RETURN_ERROR(SP_ERR_MEM, "Allocating write buffer failed");
 	}
 
 	if (config->bits >= 0)