#include <tchar.h>
#include <stdio.h>
#else
+#include <limits.h>
#include <termios.h>
#include <sys/ioctl.h>
+#include <sys/time.h>
+#include <limits.h>
+#include <poll.h>
#endif
#ifdef __APPLE__
#include <IOKit/IOKitLib.h>
#include <sys/syslimits.h>
#endif
#ifdef __linux__
+#ifdef HAVE_LIBUDEV
#include "libudev.h"
+#endif
+#ifndef __ANDROID__
#include "linux/serial.h"
+#endif
#include "linux_termios.h"
+
+/* TCGETX/TCSETX is not available everywhere. */
#if defined(TCGETX) && defined(TCSETX) && defined(HAVE_TERMIOX)
#define USE_TERMIOX
#endif
#endif
-#ifndef _WIN32
-#include "linux_termios.h"
+/* TIOCINQ/TIOCOUTQ is not available everywhere. */
+#if !defined(TIOCINQ) && defined(FIONREAD)
+#define TIOCINQ FIONREAD
+#endif
+#if !defined(TIOCOUTQ) && defined(FIONWRITE)
+#define TIOCOUTQ FIONWRITE
+#endif
+
+/* Non-standard baudrates are not available everywhere. */
+#if defined(HAVE_TERMIOS_SPEED) || defined(HAVE_TERMIOS2_SPEED)
+#define USE_TERMIOS_SPEED
#endif
#include "libserialport.h"
struct sp_port {
char *name;
- int nonblocking;
#ifdef _WIN32
HANDLE hdl;
+ COMMTIMEOUTS timeouts;
OVERLAPPED write_ovl;
+ OVERLAPPED read_ovl;
+ OVERLAPPED wait_ovl;
+ DWORD events;
BYTE pending_byte;
BOOL writing;
#else
struct termios term;
int controlbits;
int termiox_supported;
- int flow;
+ int rts_flow;
+ int cts_flow;
+ int dtr_flow;
+ int dsr_flow;
#endif
};
+#ifdef _WIN32
+typedef HANDLE event_handle;
+#else
+typedef int event_handle;
+#endif
+
/* Standard baud rates. */
#ifdef _WIN32
#define BAUD_TYPE DWORD
/* Debug output macros. */
#define DEBUG(fmt, ...) do { if (sp_debug_handler) sp_debug_handler(fmt ".\n", ##__VA_ARGS__); } while (0)
-#define DEBUG_ERROR(err, msg) DEBUG("%s returning " #err ": " msg, __func__)
-#define DEBUG_FAIL(msg) do { \
+#define DEBUG_ERROR(err, fmt, ...) DEBUG("%s returning " #err ": " fmt, __func__, ##__VA_ARGS__)
+#define DEBUG_FAIL(fmt, ...) do { \
char *errmsg = sp_last_error_message(); \
- DEBUG("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \
+ DEBUG("%s returning SP_ERR_FAIL: "fmt": %s", __func__,##__VA_ARGS__,errmsg); \
sp_free_error_message(errmsg); \
} while (0);
#define RETURN() do { DEBUG("%s returning", __func__); return; } while(0)
} \
} while (0)
#define RETURN_OK() RETURN_CODE(SP_OK);
-#define RETURN_ERROR(err, msg) do { DEBUG_ERROR(err, msg); return err; } while (0)
-#define RETURN_FAIL(msg) do { DEBUG_FAIL(msg); return SP_ERR_FAIL; } while (0)
-#define RETURN_VALUE(fmt, x) do { DEBUG("%s returning " fmt, __func__, x); return x; } while (0)
+#define RETURN_ERROR(err, ...) do { DEBUG_ERROR(err, __VA_ARGS__); return err; } while (0)
+#define RETURN_FAIL(...) do { DEBUG_FAIL(__VA_ARGS__); return SP_ERR_FAIL; } while (0)
+#define RETURN_VALUE(fmt, x) do { \
+ typeof(x) _x = x; \
+ DEBUG("%s returning " fmt, __func__, _x); \
+ return _x; \
+} while (0)
#define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0)
#define SET_FAIL(val, msg) do { DEBUG_FAIL(msg); val = SP_ERR_FAIL; } while (0)
#define TRACE(fmt, ...) DEBUG("%s(" fmt ") called", __func__, ##__VA_ARGS__)
enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr)
{
- TRACE("%p", port);
+ TRACE("%p, %p", port, result_ptr);
if (!port)
RETURN_ERROR(SP_ERR_ARG, "Null port");
{
TRACE("%p", port);
- if (!port)
- {
+ if (!port) {
DEBUG("Null port");
RETURN();
}
data_len = data_size / sizeof(TCHAR);
data[data_len] = '\0';
#ifdef UNICODE
- name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
+ name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL);
#else
name_len = data_len + 1;
#endif
IOObjectRelease(iter);
out_done:
#endif
-#ifdef __linux__
+#if defined(__linux__) && defined(HAVE_LIBUDEV)
struct udev *ud;
struct udev_enumerate *ud_enumerate;
struct udev_list_entry *ud_list;
*list_ptr = list;
RETURN_OK();
case SP_ERR_SUPP:
- DEBUG_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform.");
+ DEBUG_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
default:
if (list)
sp_free_port_list(list);
struct sp_port_config config;
enum sp_return ret;
- TRACE("%p, %x", port, flags);
+ TRACE("%p, 0x%x", port, flags);
CHECK_PORT();
- if (flags > (SP_MODE_READ | SP_MODE_WRITE | SP_MODE_NONBLOCK))
+ if (flags > (SP_MODE_READ | SP_MODE_WRITE))
RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
DEBUG("Opening port %s", port->name);
- port->nonblocking = (flags & SP_MODE_NONBLOCK) ? 1 : 0;
-
#ifdef _WIN32
- DWORD desired_access = 0, flags_and_attributes = 0;
- COMMTIMEOUTS timeouts;
+ DWORD desired_access = 0, flags_and_attributes = 0, errors;
char *escaped_port_name;
+ COMSTAT status;
/* Prefix port name with '\\.\' to work with ports above COM9. */
- if (!(escaped_port_name = malloc(strlen(port->name + 5))))
+ if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
sprintf(escaped_port_name, "\\\\.\\%s", port->name);
/* Map 'flags' to the OS-specific settings. */
- flags_and_attributes = FILE_ATTRIBUTE_NORMAL;
+ flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
if (flags & SP_MODE_READ)
desired_access |= GENERIC_READ;
if (flags & SP_MODE_WRITE)
desired_access |= GENERIC_WRITE;
- if (flags & SP_MODE_NONBLOCK)
- flags_and_attributes |= FILE_FLAG_OVERLAPPED;
port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
OPEN_EXISTING, flags_and_attributes, 0);
free(escaped_port_name);
if (port->hdl == INVALID_HANDLE_VALUE)
- RETURN_FAIL("CreateFile() failed");
-
- /* All timeouts disabled. */
- timeouts.ReadIntervalTimeout = 0;
- timeouts.ReadTotalTimeoutMultiplier = 0;
- timeouts.ReadTotalTimeoutConstant = 0;
- timeouts.WriteTotalTimeoutMultiplier = 0;
- timeouts.WriteTotalTimeoutConstant = 0;
-
- if (port->nonblocking) {
- /* Set read timeout such that all reads return immediately. */
- timeouts.ReadIntervalTimeout = MAXDWORD;
- /* Prepare OVERLAPPED structure for non-blocking writes. */
- memset(&port->write_ovl, 0, sizeof(port->write_ovl));
- if (!(port->write_ovl.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL))) {
- sp_close(port);
- RETURN_FAIL("CreateEvent() failed");
- }
- port->writing = FALSE;
- }
+ RETURN_FAIL("port CreateFile() failed");
+
+ /* All timeouts initially disabled. */
+ port->timeouts.ReadIntervalTimeout = 0;
+ port->timeouts.ReadTotalTimeoutMultiplier = 0;
+ port->timeouts.ReadTotalTimeoutConstant = 0;
+ port->timeouts.WriteTotalTimeoutMultiplier = 0;
+ port->timeouts.WriteTotalTimeoutConstant = 0;
- if (SetCommTimeouts(port->hdl, &timeouts) == 0) {
+ if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
sp_close(port);
RETURN_FAIL("SetCommTimeouts() failed");
}
+
+ /* Prepare OVERLAPPED structures. */
+#define INIT_OVERLAPPED(ovl) do { \
+ memset(&port->ovl, 0, sizeof(port->ovl)); \
+ port->ovl.hEvent = INVALID_HANDLE_VALUE; \
+ if ((port->ovl.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL)) \
+ == INVALID_HANDLE_VALUE) { \
+ sp_close(port); \
+ RETURN_FAIL(#ovl "CreateEvent() failed"); \
+ } \
+} while (0)
+
+ INIT_OVERLAPPED(read_ovl);
+ INIT_OVERLAPPED(write_ovl);
+ INIT_OVERLAPPED(wait_ovl);
+
+ /* Set event mask for RX and error events. */
+ if (SetCommMask(port->hdl, EV_RXCHAR | EV_ERR) == 0) {
+ sp_close(port);
+ 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;
+
#else
- int flags_local = 0;
+ int flags_local = O_NONBLOCK | O_NOCTTY;
/* Map 'flags' to the OS-specific settings. */
if (flags & (SP_MODE_READ | SP_MODE_WRITE))
flags_local |= O_RDONLY;
else if (flags & SP_MODE_WRITE)
flags_local |= O_WRONLY;
- if (flags & SP_MODE_NONBLOCK)
- flags_local |= O_NONBLOCK;
if ((port->fd = open(port->name, flags_local)) < 0)
RETURN_FAIL("open() failed");
data.term.c_cflag |= (CLOCAL | CREAD | HUPCL);
#endif
+#ifdef _WIN32
+ if (ClearCommError(port->hdl, &errors, &status) == 0)
+ RETURN_FAIL("ClearCommError() failed");
+#endif
+
ret = set_config(port, &data, &config);
if (ret < 0) {
#ifdef _WIN32
/* Returns non-zero upon success, 0 upon failure. */
if (CloseHandle(port->hdl) == 0)
- RETURN_FAIL("CloseHandle() failed");
+ RETURN_FAIL("port CloseHandle() failed");
port->hdl = INVALID_HANDLE_VALUE;
- if (port->nonblocking) {
- /* Close event handle created for overlapped writes. */
- if (CloseHandle(port->write_ovl.hEvent) == 0)
- RETURN_FAIL("CloseHandle() failed");
- }
+
+ /* Close event handles for overlapped structures. */
+#define CLOSE_OVERLAPPED(ovl) do { \
+ if (port->ovl.hEvent != INVALID_HANDLE_VALUE && \
+ CloseHandle(port->ovl.hEvent) == 0) \
+ RETURN_FAIL(# ovl "event CloseHandle() failed"); \
+} while (0)
+ CLOSE_OVERLAPPED(read_ovl);
+ CLOSE_OVERLAPPED(write_ovl);
+ CLOSE_OVERLAPPED(wait_ovl);
+
#else
/* Returns 0 upon success, -1 upon failure. */
if (close(port->fd) == -1)
enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
{
- TRACE("%p, %x", port, buffers);
+ TRACE("%p, 0x%x", port, buffers);
CHECK_OPEN_PORT();
/* Returns non-zero upon success, 0 upon failure. */
if (FlushFileBuffers(port->hdl) == 0)
RETURN_FAIL("FlushFileBuffers() failed");
+ RETURN_OK();
#else
- /* Returns 0 upon success, -1 upon failure. */
- if (tcdrain(port->fd) < 0)
- RETURN_FAIL("tcdrain() failed");
+ int result;
+ while (1) {
+#ifdef __ANDROID__
+ int arg = 1;
+ result = ioctl(port->fd, TCSBRK, &arg);
+#else
+ result = tcdrain(port->fd);
+#endif
+ if (result < 0) {
+ if (errno == EINTR) {
+ DEBUG("tcdrain() was interrupted");
+ continue;
+ } else {
+ RETURN_FAIL("tcdrain() failed");
+ }
+ } else {
+ RETURN_OK();
+ }
+ }
#endif
+}
- RETURN_OK();
+enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout)
+{
+ TRACE("%p, %p, %d, %d", port, buf, count, timeout);
+
+ CHECK_OPEN_PORT();
+
+ if (!buf)
+ RETURN_ERROR(SP_ERR_ARG, "Null buffer");
+
+ if (timeout)
+ DEBUG("Writing %d bytes to port %s, timeout %d ms", count, port->name, timeout);
+ else
+ DEBUG("Writing %d bytes to port %s, no timeout", count, port->name);
+
+ if (count == 0)
+ RETURN_VALUE("0", 0);
+
+#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");
+ }
+
+ /* Set timeout. */
+ port->timeouts.WriteTotalTimeoutConstant = timeout;
+ if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
+ RETURN_FAIL("SetCommTimeouts() failed");
+
+ /* Start write. */
+ if (WriteFile(port->hdl, buf, count, NULL, &port->write_ovl) == 0) {
+ if (GetLastError() == ERROR_IO_PENDING) {
+ DEBUG("Waiting for write to complete");
+ GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
+ DEBUG("Write completed, %d/%d bytes written", bytes_written, count);
+ RETURN_VALUE("%d", bytes_written);
+ } else {
+ RETURN_FAIL("WriteFile() failed");
+ }
+ } else {
+ DEBUG("Write completed immediately");
+ RETURN_VALUE("%d", count);
+ }
+#else
+ size_t bytes_written = 0;
+ unsigned char *ptr = (unsigned char *) buf;
+ struct timeval start, delta, now, end = {0, 0};
+ fd_set fds;
+ int result;
+
+ if (timeout) {
+ /* Get time at start of operation. */
+ gettimeofday(&start, NULL);
+ /* Define duration of timeout. */
+ delta.tv_sec = timeout / 1000;
+ delta.tv_usec = (timeout % 1000) * 1000;
+ /* Calculate time at which we should give up. */
+ timeradd(&start, &delta, &end);
+ }
+
+ /* Loop until we have written the requested number of bytes. */
+ 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");
+ RETURN_VALUE("%d", bytes_written);
+ }
+ timersub(&end, &now, &delta);
+ }
+ result = select(port->fd + 1, NULL, &fds, NULL, timeout ? &delta : NULL);
+ if (result < 0) {
+ if (errno == EINTR) {
+ DEBUG("select() call was interrupted, repeating");
+ continue;
+ } else {
+ RETURN_FAIL("select() failed");
+ }
+ } else if (result == 0) {
+ DEBUG("write timed out");
+ RETURN_VALUE("%d", bytes_written);
+ }
+
+ /* Do write. */
+ result = write(port->fd, ptr, count - bytes_written);
+
+ if (result < 0) {
+ if (errno == EAGAIN)
+ /* This shouldn't happen because we did a select() first, but handle anyway. */
+ continue;
+ else
+ /* This is an actual failure. */
+ RETURN_FAIL("write() failed");
+ }
+
+ bytes_written += result;
+ ptr += result;
+ }
+
+ RETURN_VALUE("%d", bytes_written);
+#endif
}
-enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count)
+enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_t count)
{
TRACE("%p, %p, %d", port, buf, count);
DWORD written = 0;
BYTE *ptr = (BYTE *) buf;
- if (port->nonblocking) {
- /* Non-blocking write. */
-
- /* Check whether previous write is complete. */
- if (port->writing) {
- if (HasOverlappedIoCompleted(&port->write_ovl)) {
- DEBUG("Previous write completed");
- port->writing = 0;
- } else {
- DEBUG("Previous write not complete");
- /* Can't take a new write until the previous one finishes. */
- RETURN_VALUE("0", 0);
- }
+ /* Check whether previous write is complete. */
+ if (port->writing) {
+ if (HasOverlappedIoCompleted(&port->write_ovl)) {
+ DEBUG("Previous write completed");
+ port->writing = 0;
+ } else {
+ DEBUG("Previous write not complete");
+ /* Can't take a new write until the previous one finishes. */
+ RETURN_VALUE("0", 0);
}
+ }
+
+ /* Set timeout. */
+ port->timeouts.WriteTotalTimeoutConstant = 0;
+ 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)
- {
- /* 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) {
- DEBUG("Asynchronous write started");
+ /* 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_VALUE("%d", ++written);
- } else {
- /* Actual failure of some kind. */
- RETURN_FAIL("WriteFile() failed");
}
} else {
- DEBUG("Single byte written immediately.");
- written++;
+ /* Actual failure of some kind. */
+ RETURN_FAIL("WriteFile() failed");
}
- }
-
- DEBUG("All bytes written immediately.");
-
- } else {
- /* Blocking write. */
- if (WriteFile(port->hdl, buf, count, &written, NULL) == 0) {
- RETURN_FAIL("WriteFile() failed");
+ } else {
+ DEBUG("Single byte written immediately");
+ written++;
}
}
+ DEBUG("All bytes written immediately");
+
RETURN_VALUE("%d", written);
#else
/* Returns the number of bytes written, or -1 upon failure. */
#endif
}
-enum sp_return sp_read(struct sp_port *port, void *buf, size_t count)
+enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout)
+{
+ TRACE("%p, %p, %d, %d", port, buf, count, timeout);
+
+ CHECK_OPEN_PORT();
+
+ if (!buf)
+ RETURN_ERROR(SP_ERR_ARG, "Null buffer");
+
+ if (timeout)
+ DEBUG("Reading %d bytes from port %s, timeout %d ms", count, port->name, timeout);
+ else
+ DEBUG("Reading %d bytes from port %s, no timeout", count, port->name);
+
+ if (count == 0)
+ RETURN_VALUE("0", 0);
+
+#ifdef _WIN32
+ DWORD bytes_read = 0;
+
+ /* Set timeout. */
+ port->timeouts.ReadIntervalTimeout = 0;
+ port->timeouts.ReadTotalTimeoutConstant = timeout;
+ if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
+ RETURN_FAIL("SetCommTimeouts() failed");
+
+ /* Start read. */
+ if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0) {
+ if (GetLastError() == ERROR_IO_PENDING) {
+ DEBUG("Waiting for read to complete");
+ GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
+ DEBUG("Read completed, %d/%d bytes read", bytes_read, count);
+ } else {
+ RETURN_FAIL("ReadFile() failed");
+ }
+ } else {
+ DEBUG("Read completed immediately");
+ 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");
+ }
+
+ RETURN_VALUE("%d", bytes_read);
+
+#else
+ size_t bytes_read = 0;
+ unsigned char *ptr = (unsigned char *) buf;
+ struct timeval start, delta, now, end = {0, 0};
+ fd_set fds;
+ int result;
+
+ if (timeout) {
+ /* Get time at start of operation. */
+ gettimeofday(&start, NULL);
+ /* Define duration of timeout. */
+ delta.tv_sec = timeout / 1000;
+ delta.tv_usec = (timeout % 1000) * 1000;
+ /* Calculate time at which we should give up. */
+ timeradd(&start, &delta, &end);
+ }
+
+ /* Loop until we have the requested number of bytes. */
+ while (bytes_read < count)
+ {
+ /* Wait until data is available. */
+ FD_ZERO(&fds);
+ FD_SET(port->fd, &fds);
+ if (timeout) {
+ gettimeofday(&now, NULL);
+ if (timercmp(&now, &end, >))
+ /* Timeout has expired. */
+ RETURN_VALUE("%d", bytes_read);
+ timersub(&end, &now, &delta);
+ }
+ result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL);
+ if (result < 0) {
+ if (errno == EINTR) {
+ DEBUG("select() call was interrupted, repeating");
+ continue;
+ } else {
+ RETURN_FAIL("select() failed");
+ }
+ } else if (result == 0) {
+ DEBUG("read timed out");
+ RETURN_VALUE("%d", bytes_read);
+ }
+
+ /* Do read. */
+ result = read(port->fd, ptr, count - bytes_read);
+
+ if (result < 0) {
+ if (errno == EAGAIN)
+ /* This shouldn't happen because we did a select() first, but handle anyway. */
+ continue;
+ else
+ /* This is an actual failure. */
+ RETURN_FAIL("read() failed");
+ }
+
+ bytes_read += result;
+ ptr += result;
+ }
+
+ RETURN_VALUE("%d", bytes_read);
+#endif
+}
+
+enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count)
{
TRACE("%p, %p, %d", port, buf, count);
DEBUG("Reading up to %d bytes from port %s", count, port->name);
#ifdef _WIN32
- DWORD bytes_read = 0;
+ DWORD bytes_read;
- /* Returns non-zero upon success, 0 upon failure. */
- if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0)
+ /* Set timeout. */
+ port->timeouts.ReadIntervalTimeout = MAXDWORD;
+ port->timeouts.ReadTotalTimeoutConstant = 0;
+ if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
+ RETURN_FAIL("SetCommTimeouts() failed");
+
+ /* Do read. */
+ if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
RETURN_FAIL("ReadFile() failed");
+
+ /* Get number of bytes read. */
+ 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");
+ }
+ }
+
RETURN_VALUE("%d", bytes_read);
#else
ssize_t bytes_read;
/* Returns the number of bytes read, or -1 upon failure. */
if ((bytes_read = read(port->fd, buf, count)) < 0) {
- if (port->nonblocking && errno == EAGAIN)
- /* Port is opened in nonblocking mode and there are no bytes available. */
+ if (errno == EAGAIN)
+ /* No bytes available. */
bytes_read = 0;
else
/* This is an actual failure. */
#endif
}
-#ifdef __linux__
+enum sp_return sp_input_waiting(struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ CHECK_OPEN_PORT();
+
+ DEBUG("Checking input bytes waiting on port %s", port->name);
+
+#ifdef _WIN32
+ DWORD errors;
+ COMSTAT comstat;
+
+ if (ClearCommError(port->hdl, &errors, &comstat) == 0)
+ RETURN_FAIL("ClearCommError() failed");
+ RETURN_VALUE("%d", comstat.cbInQue);
+#else
+ int bytes_waiting;
+ if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
+ RETURN_FAIL("TIOCINQ ioctl failed");
+ RETURN_VALUE("%d", bytes_waiting);
+#endif
+}
+
+enum sp_return sp_output_waiting(struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ CHECK_OPEN_PORT();
+
+ DEBUG("Checking output bytes waiting on port %s", port->name);
+
+#ifdef _WIN32
+ DWORD errors;
+ COMSTAT comstat;
+
+ if (ClearCommError(port->hdl, &errors, &comstat) == 0)
+ RETURN_FAIL("ClearCommError() failed");
+ RETURN_VALUE("%d", comstat.cbOutQue);
+#else
+ int bytes_waiting;
+ if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
+ RETURN_FAIL("TIOCOUTQ ioctl failed");
+ RETURN_VALUE("%d", bytes_waiting);
+#endif
+}
+
+enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
+{
+ struct sp_event_set *result;
+
+ TRACE("%p", result_ptr);
+
+ if (!result_ptr)
+ RETURN_ERROR(SP_ERR_ARG, "Null result");
+
+ *result_ptr = NULL;
+
+ if (!(result = malloc(sizeof(struct sp_event_set))))
+ RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
+
+ memset(result, 0, sizeof(struct sp_event_set));
+
+ *result_ptr = result;
+
+ RETURN_OK();
+}
+
+static enum sp_return add_handle(struct sp_event_set *event_set,
+ event_handle handle, enum sp_event mask)
+{
+ void *new_handles;
+ enum sp_event *new_masks;
+
+ TRACE("%p, %d, %d", event_set, handle, mask);
+
+ if (!(new_handles = realloc(event_set->handles,
+ sizeof(event_handle) * (event_set->count + 1))))
+ RETURN_ERROR(SP_ERR_MEM, "handle array realloc() failed");
+
+ if (!(new_masks = realloc(event_set->masks,
+ sizeof(enum sp_event) * (event_set->count + 1))))
+ 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;
+ event_set->masks[event_set->count] = mask;
+
+ event_set->count++;
+
+ RETURN_OK();
+}
+
+enum sp_return sp_add_port_events(struct sp_event_set *event_set,
+ const struct sp_port *port, enum sp_event mask)
+{
+ TRACE("%p, %p, %d", event_set, port, mask);
+
+ if (!event_set)
+ RETURN_ERROR(SP_ERR_ARG, "Null event set");
+
+ if (!port)
+ RETURN_ERROR(SP_ERR_ARG, "Null port");
+
+ if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
+ RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
+
+ if (!mask)
+ RETURN_OK();
+
+#ifdef _WIN32
+ enum sp_event handle_mask;
+ if ((handle_mask = mask & SP_EVENT_TX_READY))
+ TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
+ if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
+ TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
+#else
+ TRY(add_handle(event_set, port->fd, mask));
+#endif
+
+ RETURN_OK();
+}
+
+void sp_free_event_set(struct sp_event_set *event_set)
+{
+ TRACE("%p", event_set);
+
+ if (!event_set) {
+ DEBUG("Null event set");
+ RETURN();
+ }
+
+ DEBUG("Freeing event set");
+
+ if (event_set->handles)
+ free(event_set->handles);
+ if (event_set->masks)
+ free(event_set->masks);
+
+ free(event_set);
+
+ RETURN();
+}
+
+enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout)
+{
+ TRACE("%p, %d", event_set, timeout);
+
+ if (!event_set)
+ RETURN_ERROR(SP_ERR_ARG, "Null event set");
+
+#ifdef _WIN32
+ if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
+ timeout ? timeout : INFINITE) == WAIT_FAILED)
+ RETURN_FAIL("WaitForMultipleObjects() failed");
+
+ RETURN_OK();
+#else
+ struct timeval start, delta, now, end = {0, 0};
+ int result, timeout_remaining;
+ struct pollfd *pollfds;
+ unsigned int i;
+
+ if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
+ 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].events = 0;
+ pollfds[i].revents = 0;
+ if (event_set->masks[i] & SP_EVENT_RX_READY)
+ pollfds[i].events |= POLLIN;
+ if (event_set->masks[i] & SP_EVENT_TX_READY)
+ pollfds[i].events |= POLLOUT;
+ if (event_set->masks[i] & SP_EVENT_ERROR)
+ pollfds[i].events |= POLLERR;
+ }
+
+ if (timeout) {
+ /* Get time at start of operation. */
+ gettimeofday(&start, NULL);
+ /* Define duration of timeout. */
+ delta.tv_sec = timeout / 1000;
+ delta.tv_usec = (timeout % 1000) * 1000;
+ /* Calculate time at which we should give up. */
+ timeradd(&start, &delta, &end);
+ }
+
+ /* Loop until an event occurs. */
+ while (1)
+ {
+ if (timeout) {
+ gettimeofday(&now, NULL);
+ if (timercmp(&now, &end, >)) {
+ DEBUG("wait timed out");
+ break;
+ }
+ timersub(&end, &now, &delta);
+ timeout_remaining = delta.tv_sec * 1000 + delta.tv_usec / 1000;
+ }
+
+ result = poll(pollfds, event_set->count, timeout ? timeout_remaining : -1);
+
+ if (result < 0) {
+ if (errno == EINTR) {
+ DEBUG("poll() call was interrupted, repeating");
+ continue;
+ } else {
+ free(pollfds);
+ RETURN_FAIL("poll() failed");
+ }
+ } else if (result == 0) {
+ DEBUG("poll() timed out");
+ break;
+ } else {
+ DEBUG("poll() completed");
+ break;
+ }
+ }
+
+ free(pollfds);
+ RETURN_OK();
+#endif
+}
+
+#ifdef USE_TERMIOS_SPEED
static enum sp_return get_baudrate(int fd, int *baudrate)
{
void *data;
RETURN_OK();
}
+#endif /* USE_TERMIOS_SPEED */
#ifdef USE_TERMIOX
-static enum sp_return get_flow(int fd, int *flow)
+static enum sp_return get_flow(int fd, struct port_data *data)
{
- void *data;
+ void *termx;
- TRACE("%d, %p", fd, flow);
+ TRACE("%d, %p", fd, data);
DEBUG("Getting advanced flow control");
- if (!(data = malloc(get_termiox_size())))
+ if (!(termx = malloc(get_termiox_size())))
RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
- if (ioctl(fd, TCGETX, data) < 0) {
- free(data);
+ if (ioctl(fd, TCGETX, termx) < 0) {
+ free(termx);
RETURN_FAIL("getting termiox failed");
}
- *flow = get_termiox_flow(data);
+ get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
+ &data->dtr_flow, &data->dsr_flow);
- free(data);
+ free(termx);
RETURN_OK();
}
-static enum sp_return set_flow(int fd, int flow)
+static enum sp_return set_flow(int fd, struct port_data *data)
{
- void *data;
+ void *termx;
- TRACE("%d, %d", fd, flow);
+ TRACE("%d, %p", fd, data);
DEBUG("Getting advanced flow control");
- if (!(data = malloc(get_termiox_size())))
+ if (!(termx = malloc(get_termiox_size())))
RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
- if (ioctl(fd, TCGETX, data) < 0) {
- free(data);
+ if (ioctl(fd, TCGETX, termx) < 0) {
+ free(termx);
RETURN_FAIL("getting termiox failed");
}
DEBUG("Setting advanced flow control");
- set_termiox_flow(data, flow);
+ set_termiox_flow(termx, data->rts_flow, data->cts_flow,
+ data->dtr_flow, data->dsr_flow);
- if (ioctl(fd, TCSETX, data) < 0) {
- free(data);
+ if (ioctl(fd, TCSETX, termx) < 0) {
+ free(termx);
RETURN_FAIL("setting termiox failed");
}
- free(data);
+ free(termx);
RETURN_OK();
}
#endif /* USE_TERMIOX */
-#endif /* __linux__ */
static enum sp_return get_config(struct sp_port *port, struct port_data *data,
struct sp_port_config *config)
RETURN_FAIL("TIOCMGET ioctl failed");
#ifdef USE_TERMIOX
- int ret = get_flow(port->fd, &data->flow);
+ int ret = get_flow(port->fd, data);
if (ret == SP_ERR_FAIL && errno == EINVAL)
data->termiox_supported = 0;
if (i == NUM_STD_BAUDRATES) {
#ifdef __APPLE__
config->baudrate = (int)data->term.c_ispeed;
-#elif defined(__linux__)
+#elif defined(USE_TERMIOS_SPEED)
TRY(get_baudrate(port->fd, &config->baudrate));
#else
config->baudrate = -1;
config->rts = SP_RTS_FLOW_CONTROL;
config->cts = SP_CTS_FLOW_CONTROL;
} else {
- if (data->termiox_supported && data->flow & RTS_FLOW)
+ if (data->termiox_supported && data->rts_flow)
config->rts = SP_RTS_FLOW_CONTROL;
else
config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
- config->cts = (data->termiox_supported && data->flow & CTS_FLOW) ?
+ config->cts = (data->termiox_supported && data->cts_flow) ?
SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
}
- if (data->termiox_supported && data->flow & DTR_FLOW)
+ if (data->termiox_supported && data->dtr_flow)
config->dtr = SP_DTR_FLOW_CONTROL;
else
config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
- config->dsr = (data->termiox_supported && data->flow & DSR_FLOW) ?
+ config->dsr = (data->termiox_supported && data->dsr_flow) ?
SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
if (data->term.c_iflag & IXOFF) {
baud_nonstd = B0;
#endif
-#ifdef __linux__
+#ifdef USE_TERMIOS_SPEED
int baud_nonstd = 0;
#endif
if (config->parity >= 0) {
switch (config->parity) {
- /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
case SP_PARITY_NONE:
data->dcb.Parity = NOPARITY;
break;
if (cfsetspeed(&data->term, B9600) < 0)
RETURN_FAIL("cfsetspeed() failed");
baud_nonstd = config->baudrate;
-#elif defined(__linux__)
+#elif defined(USE_TERMIOS_SPEED)
baud_nonstd = 1;
#else
RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
case SP_PARITY_ODD:
data->term.c_cflag |= PARENB | PARODD;
break;
+#ifdef CMSPAR
case SP_PARITY_MARK:
data->term.c_cflag |= PARENB | PARODD;
-#ifdef CMSPAR
data->term.c_cflag |= CMSPAR;
-#endif
break;
case SP_PARITY_SPACE:
data->term.c_cflag |= PARENB;
-#ifdef CMSPAR
data->term.c_cflag |= CMSPAR;
-#endif
break;
+#else
+ case SP_PARITY_MARK:
+ case SP_PARITY_SPACE:
+ RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
+#endif
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
}
if (config->rts >= 0 || config->cts >= 0) {
if (data->termiox_supported) {
- data->flow &= ~(RTS_FLOW | CTS_FLOW);
+ data->rts_flow = data->cts_flow = 0;
switch (config->rts) {
case SP_RTS_OFF:
case SP_RTS_ON:
RETURN_FAIL("Setting RTS signal level failed");
break;
case SP_RTS_FLOW_CONTROL:
- data->flow |= RTS_FLOW;
+ data->rts_flow = 1;
break;
default:
break;
}
if (config->cts == SP_CTS_FLOW_CONTROL)
- data->flow |= CTS_FLOW;
+ data->cts_flow = 1;
- if (data->flow & (RTS_FLOW | CTS_FLOW))
+ if (data->rts_flow && data->cts_flow)
data->term.c_iflag |= CRTSCTS;
else
data->term.c_iflag &= ~CRTSCTS;
if (config->dtr >= 0 || config->dsr >= 0) {
if (data->termiox_supported) {
- data->flow &= ~(DTR_FLOW | DSR_FLOW);
+ data->dtr_flow = data->dsr_flow = 0;
switch (config->dtr) {
case SP_DTR_OFF:
case SP_DTR_ON:
RETURN_FAIL("Setting DTR signal level failed");
break;
case SP_DTR_FLOW_CONTROL:
- data->flow |= DTR_FLOW;
+ data->dtr_flow = 1;
break;
default:
break;
}
if (config->dsr == SP_DSR_FLOW_CONTROL)
- data->flow |= DSR_FLOW;
+ data->dsr_flow = 1;
} else {
/* DTR/DSR flow control not supported. */
if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
RETURN_FAIL("cfsetspeed() failed");
}
#elif defined(__linux__)
+#ifdef USE_TERMIOS_SPEED
if (baud_nonstd)
TRY(set_baudrate(port->fd, config->baudrate));
+#endif
#ifdef USE_TERMIOX
if (data->termiox_supported)
- TRY(set_flow(port->fd, data->flow));
+ TRY(set_flow(port->fd, data));
#endif
#endif
enum sp_return sp_new_config(struct sp_port_config **config_ptr)
{
- TRACE("%p", config_ptr);
struct sp_port_config *config;
+ TRACE("%p", config_ptr);
+
if (!config_ptr)
RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
RETURN_OK(); \
} \
enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \
- TRACE("%p", config); \
+ TRACE("%p, %p", config, x); \
if (!config) \
RETURN_ERROR(SP_ERR_ARG, "Null config"); \
*x = config->x; \
va_list args;
va_start(args, format);
if (getenv("LIBSERIALPORT_DEBUG")) {
- fputs("libserialport: ", stderr);
+ fputs("sp: ", stderr);
vfprintf(stderr, format, args);
}
va_end(args);
}
+
+int sp_get_major_package_version(void)
+{
+ return SP_PACKAGE_VERSION_MAJOR;
+}
+
+int sp_get_minor_package_version(void)
+{
+ return SP_PACKAGE_VERSION_MINOR;
+}
+
+int sp_get_micro_package_version(void)
+{
+ return SP_PACKAGE_VERSION_MICRO;
+}
+
+const char *sp_get_package_version_string(void)
+{
+ return SP_PACKAGE_VERSION_STRING;
+}
+
+int sp_get_current_lib_version(void)
+{
+ return SP_LIB_VERSION_CURRENT;
+}
+
+int sp_get_revision_lib_version(void)
+{
+ return SP_LIB_VERSION_REVISION;
+}
+
+int sp_get_age_lib_version(void)
+{
+ return SP_LIB_VERSION_AGE;
+}
+
+const char *sp_get_lib_version_string(void)
+{
+ return SP_LIB_VERSION_STRING;
+}
+
+/** @} */
projects / libserialport.git / blobdiff