#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
#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,
if (!portname)
RETURN_ERROR(SP_ERR_ARG, "Null port name");
- DEBUG("Building structure for port %s", portname);
+ DEBUG_FMT("Building structure for port %s", portname);
if (!(port = malloc(sizeof(struct sp_port))))
RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
memcpy(port->name, portname, len);
#ifdef _WIN32
+ port->usb_path = NULL;
port->hdl = INVALID_HANDLE_VALUE;
#else
port->fd = -1;
if (!port)
return NULL;
- RETURN_VALUE("%s", port->name);
+ RETURN_STRING(port->name);
}
SP_API char *sp_get_port_description(struct sp_port *port)
if (!port || !port->description)
return NULL;
- RETURN_VALUE("%s", port->description);
+ RETURN_STRING(port->description);
}
SP_API enum sp_transport sp_get_port_transport(struct sp_port *port)
if (!port)
RETURN_ERROR(SP_ERR_ARG, "Null port");
- RETURN_VALUE("%d", port->transport);
+ RETURN_INT(port->transport);
}
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();
}
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();
}
if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
return NULL;
- RETURN_VALUE("%s", port->usb_manufacturer);
+ RETURN_STRING(port->usb_manufacturer);
}
SP_API char *sp_get_port_usb_product(const struct sp_port *port)
if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
return NULL;
- RETURN_VALUE("%s", port->usb_product);
+ RETURN_STRING(port->usb_product);
}
SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
return NULL;
- RETURN_VALUE("%s", port->usb_serial);
+ RETURN_STRING(port->usb_serial);
}
SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
|| !port->bluetooth_address)
return NULL;
- RETURN_VALUE("%s", port->bluetooth_address);
+ RETURN_STRING(port->bluetooth_address);
}
SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
DEBUG("Copying port structure");
- RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr));
+ RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
}
SP_API void sp_free_port(struct sp_port *port)
}
#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
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;
CHECK_PORT();
- if (flags > (SP_MODE_READ | SP_MODE_WRITE))
+ if (flags > SP_MODE_READ_WRITE)
RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
- DEBUG("Opening port %s", port->name);
+ DEBUG_FMT("Opening port %s", port->name);
#ifdef _WIN32
DWORD desired_access = 0, flags_and_attributes = 0, errors;
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;
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;
CHECK_OPEN_PORT();
- DEBUG("Closing port %s", port->name);
+ DEBUG_FMT("Closing port %s", port->name);
#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. */
const char *buffer_names[] = {"no", "input", "output", "both"};
- DEBUG("Flushing %s buffers on port %s", buffer_names[buffers], port->name);
+ DEBUG_FMT("Flushing %s buffers on port %s",
+ buffer_names[buffers], port->name);
#ifdef _WIN32
DWORD flags = 0;
/* 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. */
CHECK_OPEN_PORT();
- DEBUG("Draining port %s", port->name);
+ DEBUG_FMT("Draining port %s", port->name);
#ifdef _WIN32
/* Returns non-zero upon success, 0 upon failure. */
RETURN_ERROR(SP_ERR_ARG, "Null buffer");
if (timeout)
- DEBUG("Writing %d bytes to port %s, timeout %d ms", count, port->name, timeout);
+ DEBUG_FMT("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);
+ DEBUG_FMT("Writing %d bytes to port %s, no timeout",
+ count, port->name);
if (count == 0)
- RETURN_VALUE("0", 0);
+ RETURN_INT(0);
#ifdef _WIN32
DWORD bytes_written = 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);
+ DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, count);
+ RETURN_INT(bytes_written);
} else {
RETURN_FAIL("WriteFile() failed");
}
} else {
DEBUG("Write completed immediately");
- RETURN_VALUE("%d", count);
+ RETURN_INT(count);
}
#else
size_t bytes_written = 0;
}
/* 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");
- RETURN_VALUE("%d", bytes_written);
+ DEBUG("Write timed out");
+ RETURN_INT(bytes_written);
}
timersub(&end, &now, &delta);
}
RETURN_FAIL("select() failed");
}
} else if (result == 0) {
- DEBUG("write timed out");
- RETURN_VALUE("%d", bytes_written);
+ DEBUG("Write timed out");
+ RETURN_INT(bytes_written);
}
/* Do write. */
ptr += result;
}
- RETURN_VALUE("%d", bytes_written);
+ RETURN_INT(bytes_written);
#endif
}
if (!buf)
RETURN_ERROR(SP_ERR_ARG, "Null buffer");
- DEBUG("Writing up to %d bytes to port %s", count, port->name);
+ DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
if (count == 0)
- RETURN_VALUE("0", 0);
+ RETURN_INT(0);
#ifdef _WIN32
DWORD written = 0;
} else {
DEBUG("Previous write not complete");
/* Can't take a new write until the previous one finishes. */
- RETURN_VALUE("0", 0);
+ RETURN_INT(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)
- {
+ /*
+ * 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++;
} else {
DEBUG("Asynchronous write running");
port->writing = 1;
- RETURN_VALUE("%d", ++written);
+ RETURN_INT(++written);
}
} else {
/* Actual failure of some kind. */
DEBUG("All bytes written immediately");
- RETURN_VALUE("%d", written);
+ RETURN_INT(written);
#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
- RETURN_VALUE("%d", written);
+ RETURN_INT(written);
#endif
}
RETURN_ERROR(SP_ERR_ARG, "Null buffer");
if (timeout)
- DEBUG("Reading %d bytes from port %s, timeout %d ms", count, port->name, timeout);
+ DEBUG_FMT("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);
+ DEBUG_FMT("Reading %d bytes from port %s, no timeout",
+ count, port->name);
if (count == 0)
- RETURN_VALUE("0", 0);
+ RETURN_INT(0);
#ifdef _WIN32
DWORD bytes_read = 0;
+ DWORD bytes_remaining;
+ int ret;
/* Set timeout. */
port->timeouts.ReadIntervalTimeout = 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);
+ DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
} else {
RETURN_FAIL("ReadFile() failed");
}
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_VALUE("%d", bytes_read);
+ RETURN_INT(bytes_read);
#else
size_t bytes_read = 0;
}
/* 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);
gettimeofday(&now, NULL);
if (timercmp(&now, &end, >))
/* Timeout has expired. */
- RETURN_VALUE("%d", bytes_read);
+ RETURN_INT(bytes_read);
timersub(&end, &now, &delta);
}
result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL);
RETURN_FAIL("select() failed");
}
} else if (result == 0) {
- DEBUG("read timed out");
- RETURN_VALUE("%d", bytes_read);
+ DEBUG("Read timed out");
+ RETURN_INT(bytes_read);
}
/* Do read. */
ptr += result;
}
- RETURN_VALUE("%d", bytes_read);
+ RETURN_INT(bytes_read);
#endif
}
if (!buf)
RETURN_ERROR(SP_ERR_ARG, "Null buffer");
- DEBUG("Reading up to %d bytes from port %s", count, port->name);
+ DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
#ifdef _WIN32
DWORD bytes_read;
+ DWORD bytes_remaining;
+ int ret;
/* Set timeout. */
port->timeouts.ReadIntervalTimeout = MAXDWORD;
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);
- RETURN_VALUE("%d", bytes_read);
+ 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
ssize_t bytes_read;
/* This is an actual failure. */
RETURN_FAIL("read() failed");
}
- RETURN_VALUE("%d", bytes_read);
+ RETURN_INT(bytes_read);
#endif
}
CHECK_OPEN_PORT();
- DEBUG("Checking input bytes waiting on port %s", port->name);
+ DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
#ifdef _WIN32
DWORD errors;
if (ClearCommError(port->hdl, &errors, &comstat) == 0)
RETURN_FAIL("ClearCommError() failed");
- RETURN_VALUE("%d", comstat.cbInQue);
+ RETURN_INT(comstat.cbInQue);
#else
int bytes_waiting;
if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
RETURN_FAIL("TIOCINQ ioctl failed");
- RETURN_VALUE("%d", bytes_waiting);
+ RETURN_INT(bytes_waiting);
#endif
}
CHECK_OPEN_PORT();
- DEBUG("Checking output bytes waiting on port %s", port->name);
+ DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
#ifdef _WIN32
DWORD errors;
if (ClearCommError(port->hdl, &errors, &comstat) == 0)
RETURN_FAIL("ClearCommError() failed");
- RETURN_VALUE("%d", comstat.cbOutQue);
+ RETURN_INT(comstat.cbOutQue);
#else
int bytes_waiting;
if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
RETURN_FAIL("TIOCOUTQ ioctl failed");
- RETURN_VALUE("%d", bytes_waiting);
+ RETURN_INT(bytes_waiting);
#endif
}
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");
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;
}
/* 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);
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);
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");
if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
free(data);
- RETURN_FAIL("setting termios failed");
+ RETURN_FAIL("Setting termios failed");
}
free(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,
if (ioctl(fd, TCGETX, termx) < 0) {
free(termx);
- RETURN_FAIL("getting termiox failed");
+ RETURN_FAIL("Getting termiox failed");
}
DEBUG("Setting advanced flow control");
if (ioctl(fd, TCSETX, termx) < 0) {
free(termx);
- RETURN_FAIL("setting termiox failed");
+ RETURN_FAIL("Setting termiox failed");
}
free(termx);
TRACE("%p, %p, %p", port, data, config);
- DEBUG("Getting configuration for port %s", port->name);
+ DEBUG_FMT("Getting configuration for port %s", port->name);
#ifdef _WIN32
if (!GetCommState(port->hdl, &data->dcb))
TRACE("%p, %p, %p", port, data, config);
- DEBUG("Setting configuration for port %s", port->name);
+ DEBUG_FMT("Setting configuration for port %s", port->name);
#ifdef _WIN32
if (config->baudrate >= 0) {
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");
}
*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;
if (!signals)
RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
- DEBUG("Getting control signals for port %s", port->name);
+ DEBUG_FMT("Getting control signals for port %s", port->name);
*signals = 0;
#ifdef _WIN32
SP_API int sp_last_error_code(void)
{
- TRACE("");
+ TRACE_VOID();
#ifdef _WIN32
- RETURN_VALUE("%d", GetLastError());
+ RETURN_INT(GetLastError());
#else
- RETURN_VALUE("%d", errno);
+ RETURN_INT(errno);
#endif
}
SP_API char *sp_last_error_message(void)
{
- TRACE("");
+ TRACE_VOID();
#ifdef _WIN32
LPVOID message;
(LPTSTR) &message,
0, NULL );
- RETURN_VALUE("%s", message);
+ RETURN_STRING(message);
#else
- RETURN_VALUE("%s", strerror(errno));
+ RETURN_STRING(strerror(errno));
#endif
}