X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=serialport.c;h=074534edb8a898c280109a25b3da9ae537e1820e;hb=025c264448de771ceb130d4d01aacbb9ca8453ea;hp=4dc1b83d0146917fcfc5927db51df905645351f5;hpb=7890cef6cf4f8496888f2a86593f9eff55244456;p=libserialport.git

diff --git a/serialport.c b/serialport.c
index 4dc1b83..074534e 100644
--- a/serialport.c
+++ b/serialport.c
@@ -24,7 +24,7 @@
 #include "libserialport.h"
 #include "libserialport_internal.h"
 
-const struct std_baudrate std_baudrates[] = {
+static const struct std_baudrate std_baudrates[] = {
 #ifdef _WIN32
 	/*
 	 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
@@ -44,6 +44,8 @@ const struct std_baudrate std_baudrates[] = {
 #endif
 };
 
+#define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
+
 void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
 
 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
@@ -85,6 +87,7 @@ SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port *
 	memcpy(port->name, portname, len);
 
 #ifdef _WIN32
+	port->usb_path = NULL;
 	port->hdl = INVALID_HANDLE_VALUE;
 #else
 	port->fd = -1;
@@ -123,7 +126,7 @@ SP_API char *sp_get_port_name(const struct sp_port *port)
 	RETURN_STRING(port->name);
 }
 
-SP_API char *sp_get_port_description(struct sp_port *port)
+SP_API char *sp_get_port_description(const struct sp_port *port)
 {
 	TRACE("%p", port);
 
@@ -133,7 +136,7 @@ SP_API char *sp_get_port_description(struct sp_port *port)
 	RETURN_STRING(port->description);
 }
 
-SP_API enum sp_transport sp_get_port_transport(struct sp_port *port)
+SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port)
 {
 	TRACE("%p", port);
 
@@ -155,8 +158,10 @@ SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
 	if (port->usb_bus < 0 || port->usb_address < 0)
 		RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available");
 
-	if (usb_bus)      *usb_bus     = port->usb_bus;
-	if (usb_address)  *usb_address = port->usb_address;
+	if (usb_bus)
+		*usb_bus = port->usb_bus;
+	if (usb_address)
+		*usb_address = port->usb_address;
 
 	RETURN_OK();
 }
@@ -173,8 +178,10 @@ SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
 	if (port->usb_vid < 0 || port->usb_pid < 0)
 		RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available");
 
-	if (usb_vid)  *usb_vid = port->usb_vid;
-	if (usb_pid)  *usb_pid = port->usb_pid;
+	if (usb_vid)
+		*usb_vid = port->usb_vid;
+	if (usb_pid)
+		*usb_pid = port->usb_pid;
 
 	RETURN_OK();
 }
@@ -315,39 +322,37 @@ fail:
 
 SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr)
 {
+#ifndef NO_ENUMERATION
 	struct sp_port **list;
 	int ret;
+#endif
 
 	TRACE("%p", list_ptr);
 
 	if (!list_ptr)
 		RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
 
+#ifdef NO_ENUMERATION
+	RETURN_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
+#else
 	DEBUG("Enumerating ports");
 
-	if (!(list = malloc(sizeof(struct sp_port **))))
+	if (!(list = malloc(sizeof(struct sp_port *))))
 		RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
 
 	list[0] = NULL;
 
-#ifdef NO_ENUMERATION
-	ret = SP_ERR_SUPP;
-#else
 	ret = list_ports(&list);
-#endif
 
-	switch (ret) {
-	case SP_OK:
+	if (ret == SP_OK) {
 		*list_ptr = list;
-		RETURN_OK();
-	case SP_ERR_SUPP:
-		DEBUG_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
-	default:
-		if (list)
-			sp_free_port_list(list);
+	} else {
+		sp_free_port_list(list);
 		*list_ptr = NULL;
-		return ret;
 	}
+
+	RETURN_CODEVAL(ret);
+#endif
 }
 
 SP_API void sp_free_port_list(struct sp_port **list)
@@ -371,9 +376,9 @@ SP_API void sp_free_port_list(struct sp_port **list)
 }
 
 #define CHECK_PORT() do { \
-	if (port == NULL) \
+	if (!port) \
 		RETURN_ERROR(SP_ERR_ARG, "Null port"); \
-	if (port->name == NULL) \
+	if (!port->name) \
 		RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
 } while (0)
 #ifdef _WIN32
@@ -392,6 +397,43 @@ SP_API void sp_free_port_list(struct sp_port **list)
 	CHECK_PORT_HANDLE(); \
 } while (0)
 
+#ifdef WIN32
+/** To be called after port receive buffer is emptied. */
+static enum sp_return restart_wait(struct sp_port *port)
+{
+	DWORD wait_result;
+
+	if (port->wait_running) {
+		/* Check status of running wait operation. */
+		if (GetOverlappedResult(port->hdl, &port->wait_ovl,
+				&wait_result, FALSE)) {
+			DEBUG("Previous wait completed");
+			port->wait_running = FALSE;
+		} else if (GetLastError() == ERROR_IO_INCOMPLETE) {
+			DEBUG("Previous wait still running");
+			RETURN_OK();
+		} else {
+			RETURN_FAIL("GetOverlappedResult() failed");
+		}
+	}
+
+	if (!port->wait_running) {
+		/* Start new wait operation. */
+		if (WaitCommEvent(port->hdl, &port->events,
+				&port->wait_ovl)) {
+			DEBUG("New wait returned, events already pending");
+		} else if (GetLastError() == ERROR_IO_PENDING) {
+			DEBUG("New wait running in background");
+			port->wait_running = TRUE;
+		} else {
+			RETURN_FAIL("WaitCommEvent() failed");
+		}
+	}
+
+	RETURN_OK();
+}
+#endif
+
 SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 {
 	struct port_data data;
@@ -402,7 +444,7 @@ SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 
 	CHECK_PORT();
 
-	if (flags > (SP_MODE_READ | SP_MODE_WRITE))
+	if (flags > SP_MODE_READ_WRITE)
 		RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
 
 	DEBUG_FMT("Opening port %s", port->name);
@@ -430,7 +472,7 @@ SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 	free(escaped_port_name);
 
 	if (port->hdl == INVALID_HANDLE_VALUE)
-		RETURN_FAIL("port CreateFile() failed");
+		RETURN_FAIL("Port CreateFile() failed");
 
 	/* All timeouts initially disabled. */
 	port->timeouts.ReadIntervalTimeout = 0;
@@ -465,21 +507,20 @@ SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 		RETURN_FAIL("SetCommMask() failed");
 	}
 
-	/* Start background operation for RX and error events. */
-	if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) {
-		if (GetLastError() != ERROR_IO_PENDING) {
-			sp_close(port);
-			RETURN_FAIL("WaitCommEvent() failed");
-		}
-	}
-
 	port->writing = FALSE;
+	port->wait_running = FALSE;
 
+	ret = restart_wait(port);
+
+	if (ret < 0) {
+		sp_close(port);
+		RETURN_CODEVAL(ret);
+	}
 #else
 	int flags_local = O_NONBLOCK | O_NOCTTY;
 
 	/* Map 'flags' to the OS-specific settings. */
-	if (flags & (SP_MODE_READ | SP_MODE_WRITE))
+	if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
 		flags_local |= O_RDWR;
 	else if (flags & SP_MODE_READ)
 		flags_local |= O_RDONLY;
@@ -503,7 +544,7 @@ SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 	data.dcb.fDsrSensitivity = FALSE;
 	data.dcb.fErrorChar = FALSE;
 	data.dcb.fNull = FALSE;
-	data.dcb.fAbortOnError = TRUE;
+	data.dcb.fAbortOnError = FALSE;
 #else
 	/* Turn off all fancy termios tricks, give us a raw channel. */
 	data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
@@ -569,7 +610,7 @@ SP_API enum sp_return sp_close(struct sp_port *port)
 #ifdef _WIN32
 	/* Returns non-zero upon success, 0 upon failure. */
 	if (CloseHandle(port->hdl) == 0)
-		RETURN_FAIL("port CloseHandle() failed");
+		RETURN_FAIL("Port CloseHandle() failed");
 	port->hdl = INVALID_HANDLE_VALUE;
 
 	/* Close event handles for overlapped structures. */
@@ -616,13 +657,16 @@ SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
 	/* Returns non-zero upon success, 0 upon failure. */
 	if (PurgeComm(port->hdl, flags) == 0)
 		RETURN_FAIL("PurgeComm() failed");
+
+	if (buffers & SP_BUF_INPUT)
+		TRY(restart_wait(port));
 #else
 	int flags = 0;
-	if (buffers & SP_BUF_BOTH)
+	if (buffers == SP_BUF_BOTH)
 		flags = TCIOFLUSH;
-	else if (buffers & SP_BUF_INPUT)
+	else if (buffers == SP_BUF_INPUT)
 		flags = TCIFLUSH;
-	else if (buffers & SP_BUF_OUTPUT)
+	else if (buffers == SP_BUF_OUTPUT)
 		flags = TCOFLUSH;
 
 	/* Returns 0 upon success, -1 upon failure. */
@@ -739,15 +783,14 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
 	}
 
 	/* Loop until we have written the requested number of bytes. */
-	while (bytes_written < count)
-	{
+	while (bytes_written < count) {
 		/* Wait until space is available. */
 		FD_ZERO(&fds);
 		FD_SET(port->fd, &fds);
 		if (timeout) {
 			gettimeofday(&now, NULL);
 			if (timercmp(&now, &end, >)) {
-				DEBUG("write timed out");
+				DEBUG("Write timed out");
 				RETURN_INT(bytes_written);
 			}
 			timersub(&end, &now, &delta);
@@ -761,7 +804,7 @@ SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
 				RETURN_FAIL("select() failed");
 			}
 		} else if (result == 0) {
-			DEBUG("write timed out");
+			DEBUG("Write timed out");
 			RETURN_INT(bytes_written);
 		}
 
@@ -821,10 +864,11 @@ SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
 	if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
 		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)
-	{
+	/*
+	 * 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++;
 
@@ -887,6 +931,8 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 
 #ifdef _WIN32
 	DWORD bytes_read = 0;
+	DWORD bytes_remaining;
+	int ret;
 
 	/* Set timeout. */
 	port->timeouts.ReadIntervalTimeout = 0;
@@ -908,11 +954,16 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 		bytes_read = count;
 	}
 
-	/* Start background operation for subsequent events. */
-	if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) {
-		if (GetLastError() != ERROR_IO_PENDING)
-			RETURN_FAIL("WaitCommEvent() failed");
-	}
+	ret = sp_input_waiting(port);
+
+	if (ret < 0)
+		RETURN_CODEVAL(ret);
+
+	bytes_remaining = ret;
+
+	/* Restart wait operation if buffer was emptied. */
+	if (bytes_read > 0 && bytes_remaining == 0)
+		TRY(restart_wait(port));
 
 	RETURN_INT(bytes_read);
 
@@ -934,8 +985,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 	}
 
 	/* Loop until we have the requested number of bytes. */
-	while (bytes_read < count)
-	{
+	while (bytes_read < count) {
 		/* Wait until data is available. */
 		FD_ZERO(&fds);
 		FD_SET(port->fd, &fds);
@@ -955,7 +1005,7 @@ SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
 				RETURN_FAIL("select() failed");
 			}
 		} else if (result == 0) {
-			DEBUG("read timed out");
+			DEBUG("Read timed out");
 			RETURN_INT(bytes_read);
 		}
 
@@ -993,6 +1043,8 @@ SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
 
 #ifdef _WIN32
 	DWORD bytes_read;
+	DWORD bytes_remaining;
+	int ret;
 
 	/* Set timeout. */
 	port->timeouts.ReadIntervalTimeout = MAXDWORD;
@@ -1008,13 +1060,16 @@ SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
 	if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
 		RETURN_FAIL("GetOverlappedResult() failed");
 
-	if (bytes_read > 0) {
-		/* Start background operation for subsequent events. */
-		if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) {
-			if (GetLastError() != ERROR_IO_PENDING)
-				RETURN_FAIL("WaitCommEvent() failed");
-		}
-	}
+	ret = sp_input_waiting(port);
+
+	if (ret < 0)
+		RETURN_CODEVAL(ret);
+
+	bytes_remaining = ret;
+
+	/* Restart wait operation if buffer was emptied. */
+	if (bytes_read > 0 && bytes_remaining == 0)
+		TRY(restart_wait(port));
 
 	RETURN_INT(bytes_read);
 #else
@@ -1110,13 +1165,14 @@ static enum sp_return add_handle(struct sp_event_set *event_set,
 
 	if (!(new_handles = realloc(event_set->handles,
 			sizeof(event_handle) * (event_set->count + 1))))
-		RETURN_ERROR(SP_ERR_MEM, "handle array realloc() failed");
+		RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed");
+
+	event_set->handles = new_handles;
 
 	if (!(new_masks = realloc(event_set->masks,
 			sizeof(enum sp_event) * (event_set->count + 1))))
-		RETURN_ERROR(SP_ERR_MEM, "mask array realloc() failed");
+		RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed");
 
-	event_set->handles = new_handles;
 	event_set->masks = new_masks;
 
 	((event_handle *) event_set->handles)[event_set->count] = handle;
@@ -1224,12 +1280,11 @@ SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
 	}
 
 	/* Loop until an event occurs. */
-	while (1)
-	{
+	while (1) {
 		if (timeout) {
 			gettimeofday(&now, NULL);
 			if (timercmp(&now, &end, >)) {
-				DEBUG("wait timed out");
+				DEBUG("Wait timed out");
 				break;
 			}
 			timersub(&end, &now, &delta);
@@ -1274,7 +1329,7 @@ static enum sp_return get_baudrate(int fd, int *baudrate)
 
 	if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
 		free(data);
-		RETURN_FAIL("getting termios failed");
+		RETURN_FAIL("Getting termios failed");
 	}
 
 	*baudrate = get_termios_speed(data);
@@ -1297,7 +1352,7 @@ static enum sp_return set_baudrate(int fd, int baudrate)
 
 	if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
 		free(data);
-		RETURN_FAIL("getting termios failed");
+		RETURN_FAIL("Getting termios failed");
 	}
 
 	DEBUG("Setting baud rate");
@@ -1306,7 +1361,7 @@ static enum sp_return set_baudrate(int fd, int baudrate)
 
 	if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
 		free(data);
-		RETURN_FAIL("setting termios failed");
+		RETURN_FAIL("Setting termios failed");
 	}
 
 	free(data);
@@ -1329,7 +1384,7 @@ static enum sp_return get_flow(int fd, struct port_data *data)
 
 	if (ioctl(fd, TCGETX, termx) < 0) {
 		free(termx);
-		RETURN_FAIL("getting termiox failed");
+		RETURN_FAIL("Getting termiox failed");
 	}
 
 	get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
@@ -1353,7 +1408,7 @@ static enum sp_return set_flow(int fd, struct port_data *data)
 
 	if (ioctl(fd, TCGETX, termx) < 0) {
 		free(termx);
-		RETURN_FAIL("getting termiox failed");
+		RETURN_FAIL("Getting termiox failed");
 	}
 
 	DEBUG("Setting advanced flow control");
@@ -1363,7 +1418,7 @@ static enum sp_return set_flow(int fd, struct port_data *data)
 
 	if (ioctl(fd, TCSETX, termx) < 0) {
 		free(termx);
-		RETURN_FAIL("setting termiox failed");
+		RETURN_FAIL("Setting termiox failed");
 	}
 
 	free(termx);
@@ -1947,8 +2002,10 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data,
 	if (baud_nonstd != B0) {
 		if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
 			RETURN_FAIL("IOSSIOSPEED ioctl failed");
-		/* Set baud rates in data->term to correct, but incompatible
-		 * with tcsetattr() value, same as delivered by tcgetattr(). */
+		/*
+		 * Set baud rates in data->term to correct, but incompatible
+		 * with tcsetattr() value, same as delivered by tcgetattr().
+		 */
 		if (cfsetspeed(&data->term, baud_nonstd) < 0)
 			RETURN_FAIL("cfsetspeed() failed");
 	}
@@ -1980,7 +2037,7 @@ SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
 	*config_ptr = NULL;
 
 	if (!(config = malloc(sizeof(struct sp_port_config))))
-		RETURN_ERROR(SP_ERR_MEM, "config malloc failed");
+		RETURN_ERROR(SP_ERR_MEM, "Config malloc failed");
 
 	config->baudrate = -1;
 	config->bits = -1;