static enum sp_return set_config(struct sp_port *port, struct port_data *data,
const struct sp_port_config *config);
+#ifndef _WIN32
+
+/* Timing abstraction */
+
+struct time {
+ struct timeval tv;
+};
+
+struct timeout {
+ unsigned int ms;
+ struct time start, delta, now, end;
+ struct timeval delta_tv;
+ bool overflow;
+};
+
+#define TIME_ZERO {.tv = {0, 0}}
+#define TIME_MS(ms) {.tv = {ms / 1000, (ms % 1000) * 1000}}
+
+const struct time max_delta = TIME_MS(INT_MAX);
+
+static void time_get(struct time *time)
+{
+#ifdef HAVE_CLOCK_GETTIME
+ struct timespec ts;
+ if (clock_gettime(CLOCK_MONOTONIC, &ts) == -1)
+ clock_gettime(CLOCK_REALTIME, &ts);
+ time->tv.tv_sec = ts.tv_sec;
+ time->tv.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.tv_sec = ns / 1000000000;
+ time->tv.tv_usec = (ns % 1000000000) / 1000;
+#else
+ gettimeofday(&time->tv, NULL);
+#endif
+}
+
+static void time_set_ms(struct time *time, unsigned int ms)
+{
+ time->tv.tv_sec = ms / 1000;
+ time->tv.tv_usec = (ms % 1000) * 1000;
+}
+
+static void time_add(const struct time *a,
+ const struct time *b, struct time *result)
+{
+ timeradd(&a->tv, &b->tv, &result->tv);
+}
+
+static void time_sub(const struct time *a,
+ const struct time *b, struct time *result)
+{
+ timersub(&a->tv, &b->tv, &result->tv);
+}
+
+static bool time_greater(const struct time *a, const struct time *b)
+{
+ return timercmp(&a->tv, &b->tv, >);
+}
+
+static void time_as_timeval(const struct time *time, struct timeval *tv)
+{
+ *tv = time->tv;
+}
+
+static unsigned int time_as_ms(const struct time *time)
+{
+ return time->tv.tv_sec * 1000 + time->tv.tv_usec / 1000;
+}
+
+static void timeout_start(struct timeout *timeout, unsigned int timeout_ms)
+{
+ timeout->ms = timeout_ms;
+
+ timeout->overflow = (timeout->ms > INT_MAX);
+
+ /* Get time at start of operation. */
+ time_get(&timeout->start);
+ /* Define duration of timeout. */
+ time_set_ms(&timeout->delta, timeout_ms);
+ /* Calculate time at which we should give up. */
+ time_add(&timeout->start, &timeout->delta, &timeout->end);
+}
+
+static bool timeout_check(struct timeout *timeout)
+{
+ if (timeout->ms == 0)
+ return false;
+
+ time_get(&timeout->now);
+ time_sub(&timeout->end, &timeout->now, &timeout->delta);
+ if ((timeout->overflow = time_greater(&timeout->delta, &max_delta)))
+ timeout->delta = max_delta;
+
+ return time_greater(&timeout->now, &timeout->end);
+}
+
+static struct timeval *timeout_timeval(struct timeout *timeout)
+{
+ if (timeout->ms == 0)
+ return NULL;
+
+ time_as_timeval(&timeout->delta, &timeout->delta_tv);
+
+ return &timeout->delta_tv;
+}
+
+static unsigned int timeout_remaining_ms(struct timeout *timeout)
+{
+ if (timeout->ms == 0)
+ return -1;
+ else if (timeout->overflow)
+ return INT_MAX;
+ else
+ return time_as_ms(&timeout->delta);
+}
+
+#endif
+
SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
{
struct sp_port *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
#ifdef _WIN32
if (port->usb_path)
free(port->usb_path);
+ if (port->write_buf)
+ free(port->write_buf);
#endif
free(port);
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;
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)
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)
#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
#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)
{
#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) {
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");
#else
size_t bytes_written = 0;
unsigned char *ptr = (unsigned char *) buf;
- struct timeval start, delta, now, end = {0, 0};
+ struct timeout timeout;
int started = 0;
fd_set fds;
int result;
- if (timeout_ms) {
- /* Get time at start of operation. */
- gettimeofday(&start, NULL);
- /* Define duration of timeout. */
- delta.tv_sec = timeout_ms / 1000;
- delta.tv_usec = (timeout_ms % 1000) * 1000;
- /* Calculate time at which we should give up. */
- timeradd(&start, &delta, &end);
- }
+ timeout_start(&timeout, timeout_ms);
FD_ZERO(&fds);
FD_SET(port->fd, &fds);
* to avoid any issues if a short timeout is reached before
* select() is even run.
*/
- if (timeout_ms && started) {
- gettimeofday(&now, NULL);
- if (timercmp(&now, &end, >))
- /* Timeout has expired. */
- break;
- timersub(&end, &now, &delta);
- }
- result = select(port->fd + 1, NULL, &fds, NULL, timeout_ms ? &delta : NULL);
+ if (started && timeout_check(&timeout))
+ break;
+
+ result = select(port->fd + 1, NULL, &fds, NULL, timeout_timeval(&timeout));
started = 1;
if (result < 0) {
if (errno == EINTR) {
RETURN_INT(0);
#ifdef _WIN32
- DWORD written = 0;
- BYTE *ptr = (BYTE *) buf;
+ DWORD buf_bytes;
/* Check whether previous write is complete. */
if (port->writing) {
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
}
#else
size_t bytes_read = 0;
unsigned char *ptr = (unsigned char *) buf;
- struct timeval start, delta, now, end = {0, 0};
+ struct timeout timeout;
int started = 0;
fd_set fds;
int result;
- if (timeout_ms) {
- /* Get time at start of operation. */
- gettimeofday(&start, NULL);
- /* Define duration of timeout. */
- delta.tv_sec = timeout_ms / 1000;
- delta.tv_usec = (timeout_ms % 1000) * 1000;
- /* Calculate time at which we should give up. */
- timeradd(&start, &delta, &end);
- }
+ timeout_start(&timeout, timeout_ms);
FD_ZERO(&fds);
FD_SET(port->fd, &fds);
* to avoid any issues if a short timeout is reached before
* select() is even run.
*/
- if (timeout_ms && started) {
- gettimeofday(&now, NULL);
- if (timercmp(&now, &end, >))
- /* Timeout has expired. */
- break;
- timersub(&end, &now, &delta);
- }
- result = select(port->fd + 1, &fds, NULL, NULL, timeout_ms ? &delta : NULL);
+ if (started && timeout_check(&timeout))
+ /* Timeout has expired. */
+ break;
+
+ result = select(port->fd + 1, &fds, NULL, NULL, timeout_timeval(&timeout));
started = 1;
if (result < 0) {
if (errno == EINTR) {
#else
size_t bytes_read = 0;
- struct timeval start, delta, now, end = {0, 0};
+ struct timeout timeout;
int started = 0;
fd_set fds;
int result;
- if (timeout_ms) {
- /* Get time at start of operation. */
- gettimeofday(&start, NULL);
- /* Define duration of timeout. */
- delta.tv_sec = timeout_ms / 1000;
- delta.tv_usec = (timeout_ms % 1000) * 1000;
- /* Calculate time at which we should give up. */
- timeradd(&start, &delta, &end);
- }
+ timeout_start(&timeout, timeout_ms);
FD_ZERO(&fds);
FD_SET(port->fd, &fds);
* to avoid any issues if a short timeout is reached before
* select() is even run.
*/
- if (timeout_ms && started) {
- gettimeofday(&now, NULL);
- if (timercmp(&now, &end, >))
- /* Timeout has expired. */
- break;
- timersub(&end, &now, &delta);
- }
- result = select(port->fd + 1, &fds, NULL, NULL, timeout_ms ? &delta : NULL);
+ if (started && timeout_check(&timeout))
+ /* Timeout has expired. */
+ break;
+
+ result = select(port->fd + 1, &fds, NULL, NULL, timeout_timeval(&timeout));
started = 1;
if (result < 0) {
if (errno == EINTR) {
RETURN_OK();
#else
- struct timeval start, delta, now, end = {0, 0};
- const struct timeval max_delta = {
- (INT_MAX / 1000), (INT_MAX % 1000) * 1000};
- int started = 0, timeout_overflow = 0;
- int result, timeout_remaining_ms;
+ struct timeout timeout;
+ int started = 0, result;
struct pollfd *pollfds;
unsigned int i;
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)
pollfds[i].events |= POLLERR;
}
- if (timeout_ms) {
- /* Get time at start of operation. */
- gettimeofday(&start, NULL);
- /* Define duration of timeout. */
- delta.tv_sec = timeout_ms / 1000;
- delta.tv_usec = (timeout_ms % 1000) * 1000;
- /* Calculate time at which we should give up. */
- timeradd(&start, &delta, &end);
- }
+ timeout_start(&timeout, timeout_ms);
/* Loop until an event occurs. */
while (1) {
* to avoid any issues if a short timeout is reached before
* poll() is even run.
*/
- if (!timeout_ms) {
- timeout_remaining_ms = -1;
- } else if (!started) {
- timeout_overflow = (timeout_ms > INT_MAX);
- timeout_remaining_ms = timeout_overflow ? INT_MAX : timeout_ms;
- } else {
- gettimeofday(&now, NULL);
- if (timercmp(&now, &end, >)) {
- DEBUG("Wait timed out");
- break;
- }
- timersub(&end, &now, &delta);
- if ((timeout_overflow = timercmp(&delta, &max_delta, >)))
- delta = max_delta;
- timeout_remaining_ms = delta.tv_sec * 1000 + delta.tv_usec / 1000;
+ if (started && timeout_check(&timeout)) {
+ DEBUG("Wait timed out");
+ break;
}
- result = poll(pollfds, event_set->count, timeout_remaining_ms);
+ result = poll(pollfds, event_set->count, timeout_remaining_ms(&timeout));
started = 1;
if (result < 0) {
}
} else if (result == 0) {
DEBUG("poll() timed out");
- if (!timeout_overflow)
+ if (!timeout.overflow)
break;
} else {
DEBUG("poll() completed");
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) {
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)
projects / libserialport.git / blobdiff