#include <unistd.h>
#include <stdlib.h>
#include <errno.h>
+#include <stdio.h>
+#include <stdarg.h>
#ifdef _WIN32
#include <windows.h>
#include <tchar.h>
#endif
#endif
+#ifndef _WIN32
+#include "linux_termios.h"
+#endif
+
#include "libserialport.h"
+struct sp_port {
+ char *name;
+#ifdef _WIN32
+ HANDLE hdl;
+#else
+ int fd;
+#endif
+};
+
struct port_data {
#ifdef _WIN32
DCB dcb;
#else
struct termios term;
int controlbits;
-#ifdef USE_TERMIOX
+ int termiox_supported;
int flow;
#endif
-#endif
};
/* Standard baud rates. */
#endif
};
+void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
+
#define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
#define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
-#define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0)
+/* 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 { \
+ char *errmsg = sp_last_error_message(); \
+ DEBUG("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \
+ sp_free_error_message(errmsg); \
+} while (0);
+#define RETURN() do { DEBUG("%s returning", __func__); return; } while(0)
+#define RETURN_CODE(x) do { DEBUG("%s returning " #x, __func__); return x; } while (0)
+#define RETURN_CODEVAL(x) do { \
+ switch (x) { \
+ case SP_OK: RETURN_CODE(SP_OK); \
+ case SP_ERR_ARG: RETURN_CODE(SP_ERR_ARG); \
+ case SP_ERR_FAIL: RETURN_CODE(SP_ERR_FAIL); \
+ case SP_ERR_MEM: RETURN_CODE(SP_ERR_MEM); \
+ case SP_ERR_SUPP: RETURN_CODE(SP_ERR_SUPP); \
+ } \
+} 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 SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0)
+#define SET_FAIL(val, msg) do { DEBUG_FAIL(msg); val = err; } while (0)
+#define TRACE(fmt, ...) DEBUG("%s(" fmt ") called", __func__, ##__VA_ARGS__)
+
+#define TRY(x) do { int ret = x; if (ret != SP_OK) RETURN_CODEVAL(ret); } while (0)
/* Helper functions. */
-static enum sp_return validate_port(struct sp_port *port);
static struct sp_port **list_append(struct sp_port **list, const char *portname);
static enum sp_return get_config(struct sp_port *port, struct port_data *data,
struct sp_port_config *config);
struct sp_port *port;
int len;
+ TRACE("%s, %p", portname, port_ptr);
+
if (!port_ptr)
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
*port_ptr = NULL;
if (!portname)
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Null port name");
+
+ DEBUG("Building structure for port %s", portname);
if (!(port = malloc(sizeof(struct sp_port))))
- return SP_ERR_MEM;
+ RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
len = strlen(portname) + 1;
if (!(port->name = malloc(len))) {
free(port);
- return SP_ERR_MEM;
+ RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
}
memcpy(port->name, portname, len);
*port_ptr = port;
- return SP_OK;
+ RETURN_OK();
+}
+
+char *sp_get_port_name(const struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ if (!port)
+ return NULL;
+
+ RETURN_VALUE("%s", port->name);
+}
+
+enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr)
+{
+ TRACE("%p", port);
+
+ if (!port)
+ RETURN_ERROR(SP_ERR_ARG, "Null port");
+
+#ifdef _WIN32
+ HANDLE *handle_ptr = result_ptr;
+ *handle_ptr = port->hdl;
+#else
+ int *fd_ptr = result_ptr;
+ *fd_ptr = port->fd;
+#endif
+
+ RETURN_OK();
}
enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
{
+ TRACE("%p, %p", port, copy_ptr);
+
if (!copy_ptr)
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
*copy_ptr = NULL;
- if (!port || !port->name)
- return SP_ERR_ARG;
+ if (!port)
+ RETURN_ERROR(SP_ERR_ARG, "Null port");
+
+ if (!port->name)
+ RETURN_ERROR(SP_ERR_ARG, "Null port name");
+
+ DEBUG("Copying port structure");
- return sp_get_port_by_name(port->name, copy_ptr);
+ RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr));
}
void sp_free_port(struct sp_port *port)
{
+ TRACE("%p", port);
+
if (!port)
- return;
+ {
+ DEBUG("Null port");
+ RETURN();
+ }
+
+ DEBUG("Freeing port structure");
if (port->name)
free(port->name);
free(port);
+
+ RETURN();
}
static struct sp_port **list_append(struct sp_port **list, const char *portname)
enum sp_return sp_list_ports(struct sp_port ***list_ptr)
{
struct sp_port **list;
- int ret = SP_OK;
+ int ret = SP_ERR_SUPP;
+
+ TRACE("%p", list_ptr);
+
+ if (!list_ptr)
+ RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
+
+ DEBUG("Enumerating ports");
if (!(list = malloc(sizeof(struct sp_port **))))
- return SP_ERR_MEM;
+ RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
list[0] = NULL;
char *name;
int name_len;
+ ret = SP_OK;
+
+ DEBUG("Opening registry key");
if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) {
- ret = SP_ERR_FAIL;
+ SET_FAIL(ret, "RegOpenKeyEx() failed");
goto out_done;
}
+ DEBUG("Querying registry key value and data sizes");
if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
&max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) {
- ret = SP_ERR_FAIL;
+ SET_FAIL(ret, "RegQueryInfoKey() failed");
goto out_close;
}
max_data_len = max_data_size / sizeof(TCHAR);
if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) {
- ret = SP_ERR_MEM;
+ SET_ERROR(ret, SP_ERR_MEM, "registry value malloc failed");
goto out_close;
}
if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) {
- ret = SP_ERR_MEM;
+ SET_ERROR(ret, SP_ERR_MEM, "registry data malloc failed");
goto out_free_value;
}
+ DEBUG("Iterating over values");
while (
value_len = max_value_len + 1,
data_size = max_data_size,
name_len = data_len + 1;
#endif
if (!(name = malloc(name_len))) {
- ret = SP_ERR_MEM;
+ SET_ERROR(ret, SP_ERR_MEM, "registry port name malloc failed");
goto out;
}
#ifdef UNICODE
#else
strcpy(name, data);
#endif
- if (type == REG_SZ && !(list = list_append(list, name))) {
- ret = SP_ERR_MEM;
- goto out;
+ if (type == REG_SZ) {
+ DEBUG("Found port %s", name);
+ if (!(list = list_append(list, name))) {
+ SET_ERROR(ret, SP_ERR_MEM, "list append failed");
+ goto out;
+ }
}
index++;
}
CFTypeRef cf_path;
Boolean result;
+ ret = SP_OK;
+
+ DEBUG("Getting IOKit master port");
if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) {
- ret = SP_ERR_FAIL;
+ SET_FAIL(ret, "IOMasterPort() failed");
goto out_done;
}
+ DEBUG("Creating matching dictionary");
if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) {
- ret = SP_ERR_FAIL;
+ SET_FAIL(ret, "IOServiceMatching() failed");
goto out_done;
}
CFDictionarySetValue(classes,
CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
+ DEBUG("Getting matching services");
if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS) {
- ret = SP_ERR_FAIL;
+ SET_FAIL(ret, "IOServiceGetMatchingServices() failed");
goto out_done;
}
if (!(path = malloc(PATH_MAX))) {
- ret = SP_ERR_MEM;
+ SET_ERROR(ret, SP_ERR_MEM, "device path malloc failed");
goto out_release;
}
+ DEBUG("Iterating over results");
while ((port = IOIteratorNext(iter))) {
cf_path = IORegistryEntryCreateCFProperty(port,
CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
result = CFStringGetCString(cf_path,
path, PATH_MAX, kCFStringEncodingASCII);
CFRelease(cf_path);
- if (result && !(list = list_append(list, path))) {
- ret = SP_ERR_MEM;
- IOObjectRelease(port);
- goto out;
+ if (result) {
+ DEBUG("Found port %s", path);
+ if (!(list = list_append(list, path))) {
+ SET_ERROR(ret, SP_ERR_MEM, "list append failed");
+ IOObjectRelease(port);
+ goto out;
+ }
}
}
IOObjectRelease(port);
int fd, ioctl_result;
struct serial_struct serial_info;
+ ret = SP_OK;
+
+ DEBUG("Enumerating tty devices");
ud = udev_new();
ud_enumerate = udev_enumerate_new(ud);
udev_enumerate_add_match_subsystem(ud_enumerate, "tty");
udev_enumerate_scan_devices(ud_enumerate);
ud_list = udev_enumerate_get_list_entry(ud_enumerate);
+ DEBUG("Iterating over results");
udev_list_entry_foreach(ud_entry, ud_list) {
path = udev_list_entry_get_name(ud_entry);
+ DEBUG("Found device %s", path);
ud_dev = udev_device_new_from_syspath(ud, path);
/* If there is no parent device, this is a virtual tty. */
ud_parent = udev_device_get_parent(ud_dev);
if (ud_parent == NULL) {
+ DEBUG("No parent device, assuming virtual tty");
udev_device_unref(ud_dev);
continue;
}
* is to try to open them and make an ioctl call. */
driver = udev_device_get_driver(ud_parent);
if (driver && !strcmp(driver, "serial8250")) {
- if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0)
+ DEBUG("serial8250 device, attempting to open");
+ if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) {
+ DEBUG("open failed, skipping");
goto skip;
+ }
ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
close(fd);
- if (ioctl_result != 0)
+ if (ioctl_result != 0) {
+ DEBUG("ioctl failed, skipping");
goto skip;
- if (serial_info.type == PORT_UNKNOWN)
+ }
+ if (serial_info.type == PORT_UNKNOWN) {
+ DEBUG("port type is unknown, skipping");
goto skip;
+ }
}
+ DEBUG("Found port %s", name);
list = list_append(list, name);
skip:
udev_device_unref(ud_dev);
if (!list) {
- ret = SP_ERR_MEM;
+ SET_ERROR(ret, SP_ERR_MEM, "list append failed");
goto out;
}
}
udev_unref(ud);
#endif
- if (ret == SP_OK) {
+ switch (ret) {
+ case SP_OK:
*list_ptr = list;
- } else {
+ 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);
*list_ptr = NULL;
+ return ret;
}
-
- return ret;
}
void sp_free_port_list(struct sp_port **list)
{
unsigned int i;
+ TRACE("%p", list);
+
+ if (!list) {
+ DEBUG("Null list");
+ RETURN();
+ }
+
+ DEBUG("Freeing port list");
+
for (i = 0; list[i]; i++)
sp_free_port(list[i]);
free(list);
+
+ RETURN();
}
-static enum sp_return validate_port(struct sp_port *port)
-{
- if (port == NULL)
- return 0;
+#define CHECK_PORT() do { \
+ if (port == NULL) \
+ RETURN_ERROR(SP_ERR_ARG, "Null port"); \
+ if (port->name == NULL) \
+ RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
+} while (0)
#ifdef _WIN32
- if (port->hdl == INVALID_HANDLE_VALUE)
- return 0;
+#define CHECK_PORT_HANDLE() do { \
+ if (port->hdl == INVALID_HANDLE_VALUE) \
+ RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
+} while (0)
#else
- if (port->fd < 0)
- return 0;
+#define CHECK_PORT_HANDLE() do { \
+ if (port->fd < 0) \
+ RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
+} while (0)
#endif
- return 1;
-}
-
-#define CHECK_PORT() do { if (!validate_port(port)) return SP_ERR_ARG; } while (0)
+#define CHECK_OPEN_PORT() do { \
+ CHECK_PORT(); \
+ CHECK_PORT_HANDLE(); \
+} while (0)
enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
{
- if (!port)
- return SP_ERR_ARG;
+ TRACE("%p, %x", port, flags);
+
+ CHECK_PORT();
+
+ if (flags > (SP_MODE_READ | SP_MODE_WRITE | SP_MODE_NONBLOCK))
+ RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
+
+ DEBUG("Opening port %s", port->name);
#ifdef _WIN32
DWORD desired_access = 0, flags_and_attributes = 0;
/* Prefix port name with '\\.\' to work with ports above COM9. */
if (!(escaped_port_name = malloc(strlen(port->name + 5))))
- return SP_ERR_MEM;
+ RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
sprintf(escaped_port_name, "\\\\.\\%s", port->name);
/* Map 'flags' to the OS-specific settings. */
free(escaped_port_name);
if (port->hdl == INVALID_HANDLE_VALUE)
- return SP_ERR_FAIL;
+ RETURN_FAIL("CreateFile() failed");
#else
int flags_local = 0;
struct port_data data;
flags_local |= O_NONBLOCK;
if ((port->fd = open(port->name, flags_local)) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("open() failed");
ret = get_config(port, &data, &config);
if (ret < 0) {
sp_close(port);
- return ret;
+ RETURN_CODEVAL(ret);
}
/* Turn off all serial port cooking. */
if (ret < 0) {
sp_close(port);
- return ret;
+ RETURN_CODEVAL(ret);
}
#endif
- return SP_OK;
+ RETURN_OK();
}
enum sp_return sp_close(struct sp_port *port)
{
- CHECK_PORT();
+ TRACE("%p", port);
+
+ CHECK_OPEN_PORT();
+
+ DEBUG("Closing port %s", port->name);
#ifdef _WIN32
/* Returns non-zero upon success, 0 upon failure. */
if (CloseHandle(port->hdl) == 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("CloseHandle() failed");
port->hdl = INVALID_HANDLE_VALUE;
#else
/* Returns 0 upon success, -1 upon failure. */
if (close(port->fd) == -1)
- return SP_ERR_FAIL;
+ RETURN_FAIL("close() failed");
port->fd = -1;
#endif
- return SP_OK;
+ RETURN_OK();
}
enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
{
- CHECK_PORT();
+ TRACE("%p, %x", port, buffers);
+
+ CHECK_OPEN_PORT();
+
+ if (buffers > SP_BUF_BOTH)
+ RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
+
+ const char *buffer_names[] = {"input", "output", "both"};
+
+ DEBUG("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 SP_ERR_FAIL;
+ RETURN_FAIL("PurgeComm() failed");
#else
int flags = 0;
if (buffers & SP_BUF_BOTH)
/* Returns 0 upon success, -1 upon failure. */
if (tcflush(port->fd, flags) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("tcflush() failed");
#endif
- return SP_OK;
+ RETURN_OK();
}
enum sp_return sp_drain(struct sp_port *port)
{
- CHECK_PORT();
+ TRACE("%p", port);
+
+ CHECK_OPEN_PORT();
+
+ DEBUG("Draining port %s", port->name);
#ifdef _WIN32
/* Returns non-zero upon success, 0 upon failure. */
if (FlushFileBuffers(port->hdl) == 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("FlushFileBuffers() failed");
#else
/* Returns 0 upon success, -1 upon failure. */
if (tcdrain(port->fd) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("tcdrain() failed");
#endif
- return SP_OK;
+ RETURN_OK();
}
enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count)
{
- CHECK_PORT();
+ TRACE("%p, %p, %d", port, buf, count);
+
+ CHECK_OPEN_PORT();
if (!buf)
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Null buffer");
+
+ DEBUG("Writing up to %d bytes to port %s", count, port->name);
#ifdef _WIN32
DWORD written = 0;
/* Returns non-zero upon success, 0 upon failure. */
if (WriteFile(port->hdl, buf, count, &written, NULL) == 0)
- return SP_ERR_FAIL;
- return written;
+ RETURN_FAIL("WriteFile() failed");
+ RETURN_VALUE("%d", written);
#else
/* Returns the number of bytes written, or -1 upon failure. */
ssize_t written = write(port->fd, buf, count);
if (written < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("write() failed");
else
- return written;
+ RETURN_VALUE("%d", written);
#endif
}
enum sp_return sp_read(struct sp_port *port, void *buf, size_t count)
{
- CHECK_PORT();
+ TRACE("%p, %p, %d", port, buf, count);
+
+ CHECK_OPEN_PORT();
if (!buf)
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Null buffer");
+
+ DEBUG("Reading up to %d bytes from port %s", count, port->name);
#ifdef _WIN32
DWORD bytes_read = 0;
/* Returns non-zero upon success, 0 upon failure. */
if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0)
- return SP_ERR_FAIL;
- return bytes_read;
+ RETURN_FAIL("ReadFile() 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)
- return SP_ERR_FAIL;
- return bytes_read;
+ RETURN_FAIL("read() failed");
+ RETURN_VALUE("%d", bytes_read);
#endif
}
{
void *data;
+ TRACE("%d, %p", fd, baudrate);
+
+ DEBUG("Getting baud rate");
+
if (!(data = malloc(get_termios_size())))
- return SP_ERR_MEM;
+ RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
- if (ioctl(fd, get_termios_get_ioctl(), data) < 0)
- return SP_ERR_FAIL;
+ if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
+ free(data);
+ RETURN_FAIL("getting termios failed");
+ }
*baudrate = get_termios_speed(data);
- return SP_OK;
+ free(data);
+
+ RETURN_OK();
}
static enum sp_return set_baudrate(int fd, int baudrate)
{
void *data;
+ TRACE("%d, %d", fd, baudrate);
+
+ DEBUG("Getting baud rate");
+
if (!(data = malloc(get_termios_size())))
- return SP_ERR_MEM;
+ RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
- if (ioctl(fd, get_termios_get_ioctl(), data) < 0)
- return SP_ERR_FAIL;
+ if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
+ free(data);
+ RETURN_FAIL("getting termios failed");
+ }
+
+ DEBUG("Setting baud rate");
set_termios_speed(data, baudrate);
- if (ioctl(fd, get_termios_set_ioctl(), data) < 0)
- return SP_ERR_FAIL;
+ if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
+ free(data);
+ RETURN_FAIL("setting termios failed");
+ }
+
+ free(data);
- return SP_OK;
+ RETURN_OK();
}
#ifdef USE_TERMIOX
{
void *data;
+ TRACE("%d, %p", fd, flow);
+
+ DEBUG("Getting advanced flow control");
+
if (!(data = malloc(get_termiox_size())))
- return SP_ERR_MEM;
+ RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
- if (ioctl(fd, TCGETX, data) < 0)
- return SP_ERR_FAIL;
+ if (ioctl(fd, TCGETX, data) < 0) {
+ free(data);
+ RETURN_FAIL("getting termiox failed");
+ }
*flow = get_termiox_flow(data);
- return SP_OK;
+ free(data);
+
+ RETURN_OK();
}
static enum sp_return set_flow(int fd, int flow)
{
void *data;
+ TRACE("%d, %d", fd, flow);
+
+ DEBUG("Getting advanced flow control");
+
if (!(data = malloc(get_termiox_size())))
- return SP_ERR_MEM;
+ RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
+
+ if (ioctl(fd, TCGETX, data) < 0) {
+ free(data);
+ RETURN_FAIL("getting termiox failed");
+ }
- if (ioctl(fd, TCGETX, data) < 0)
- return SP_ERR_FAIL;
+ DEBUG("Setting advanced flow control");
set_termiox_flow(data, flow);
- if (ioctl(fd, TCSETX, data) < 0)
- return SP_ERR_FAIL;
+ if (ioctl(fd, TCSETX, data) < 0) {
+ free(data);
+ RETURN_FAIL("setting termiox failed");
+ }
+
+ free(data);
- return SP_OK;
+ RETURN_OK();
}
#endif /* USE_TERMIOX */
#endif /* __linux__ */
{
unsigned int i;
+ TRACE("%p, %p, %p", port, data, config);
+
+ DEBUG("Getting configuration for port %s", port->name);
+
#ifdef _WIN32
if (!GetCommState(port->hdl, &data->dcb))
- return SP_ERR_FAIL;
+ RETURN_FAIL("GetCommState() failed");
for (i = 0; i < NUM_STD_BAUDRATES; i++) {
if (data->dcb.BaudRate == std_baudrates[i].index) {
#else // !_WIN32
if (tcgetattr(port->fd, &data->term) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("tcgetattr() failed");
if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("TIOCMGET ioctl failed");
#ifdef USE_TERMIOX
- TRY(get_flow(port->fd, &data->flow));
+ int ret = get_flow(port->fd, &data->flow);
+
+ if (ret == SP_ERR_FAIL && errno == EINVAL)
+ data->termiox_supported = 0;
+ else if (ret < 0)
+ RETURN_CODEVAL(ret);
+ else
+ data->termiox_supported = 1;
+#else
+ data->termiox_supported = 0;
#endif
for (i = 0; i < NUM_STD_BAUDRATES; i++) {
config->rts = SP_RTS_FLOW_CONTROL;
config->cts = SP_CTS_FLOW_CONTROL;
} else {
-#ifdef USE_TERMIOX
- if (data->flow & RTS_FLOW)
+ if (data->termiox_supported && data->flow & RTS_FLOW)
config->rts = SP_RTS_FLOW_CONTROL;
else
config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
- config->cts = (data->flow & CTS_FLOW) ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
-#else
- config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
- config->cts = SP_CTS_IGNORE;
-#endif
+ config->cts = (data->termiox_supported && data->flow & CTS_FLOW) ?
+ SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
}
-#ifdef USE_TERMIOX
- if (data->flow & DTR_FLOW)
+ if (data->termiox_supported && data->flow & DTR_FLOW)
config->dtr = SP_DTR_FLOW_CONTROL;
else
config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
- config->dsr = (data->flow & DSR_FLOW) ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
-#else
- config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
- config->dsr = SP_DSR_IGNORE;
-#endif
+ config->dsr = (data->termiox_supported && data->flow & DSR_FLOW) ?
+ SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
if (data->term.c_iflag & IXOFF) {
if (data->term.c_iflag & IXON)
}
#endif
- return SP_OK;
+ RETURN_OK();
}
static enum sp_return set_config(struct sp_port *port, struct port_data *data,
int baud_nonstd = 0;
#endif
+ TRACE("%p, %p, %p", port, data, config);
+
+ DEBUG("Setting configuration for port %s", port->name);
+
#ifdef _WIN32
if (config->baudrate >= 0) {
for (i = 0; i < NUM_STD_BAUDRATES; i++) {
data->dcb.Parity = ODDPARITY;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
}
}
data->dcb.StopBits = TWOSTOPBITS;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
}
}
data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
}
}
data->dcb.fOutxCtsFlow = TRUE;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
}
}
data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
}
}
data->dcb.fOutxDsrFlow = TRUE;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
}
}
data->dcb.fOutX = TRUE;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
}
}
if (!SetCommState(port->hdl, &data->dcb))
- return SP_ERR_FAIL;
+ RETURN_FAIL("SetCommState() failed");
#else /* !_WIN32 */
for (i = 0; i < NUM_STD_BAUDRATES; i++) {
if (config->baudrate == std_baudrates[i].value) {
if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("cfsetospeed() failed");
if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("cfsetispeed() failed");
break;
}
}
/* Non-standard baud rate */
if (i == NUM_STD_BAUDRATES) {
#ifdef __APPLE__
- /* Set "dummy" baud rate */
+ /* Set "dummy" baud rate. */
if (cfsetspeed(&data->term, B9600) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("cfsetspeed() failed");
baud_nonstd = config->baudrate;
#elif defined(__linux__)
baud_nonstd = 1;
#else
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
#endif
}
}
data->term.c_cflag |= CS5;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
}
}
data->term.c_cflag |= PARENB | PARODD;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
}
}
data->term.c_cflag |= CSTOPB;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
}
}
if (config->rts >= 0 || config->cts >= 0) {
-#ifdef USE_TERMIOX
- data->flow &= ~(RTS_FLOW | CTS_FLOW);
- switch (config->rts) {
+ if (data->termiox_supported) {
+ data->flow &= ~(RTS_FLOW | CTS_FLOW);
+ switch (config->rts) {
case SP_RTS_OFF:
case SP_RTS_ON:
controlbits = TIOCM_RTS;
- if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
- &controlbits) < 0)
- return SP_ERR_FAIL;
+ if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
+ RETURN_FAIL("Setting RTS signal level failed");
break;
case SP_RTS_FLOW_CONTROL:
data->flow |= RTS_FLOW;
break;
default:
break;
- }
- if (config->cts == SP_CTS_FLOW_CONTROL)
- data->flow |= CTS_FLOW;
-
- if (data->flow & (RTS_FLOW | CTS_FLOW))
- data->term.c_iflag |= CRTSCTS;
- else
- data->term.c_iflag &= ~CRTSCTS;
-#else
- /* Asymmetric use of RTS/CTS not supported. */
- if (data->term.c_iflag & CRTSCTS) {
- /* Flow control can only be disabled for both RTS & CTS together. */
- if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
- if (config->cts != SP_CTS_IGNORE)
- return SP_ERR_ARG;
- }
- if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
- if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
- return SP_ERR_ARG;
}
- } else {
- /* Flow control can only be enabled for both RTS & CTS together. */
- if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
- ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
- return SP_ERR_ARG;
- }
+ if (config->cts == SP_CTS_FLOW_CONTROL)
+ data->flow |= CTS_FLOW;
- if (config->rts >= 0) {
- if (config->rts == SP_RTS_FLOW_CONTROL) {
+ if (data->flow & (RTS_FLOW | CTS_FLOW))
data->term.c_iflag |= CRTSCTS;
+ else
+ data->term.c_iflag &= ~CRTSCTS;
+ } else {
+ /* Asymmetric use of RTS/CTS not supported. */
+ if (data->term.c_iflag & CRTSCTS) {
+ /* Flow control can only be disabled for both RTS & CTS together. */
+ if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
+ if (config->cts != SP_CTS_IGNORE)
+ RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
+ }
+ if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
+ if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
+ RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
+ }
} else {
- controlbits = TIOCM_RTS;
- if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
- &controlbits) < 0)
- return SP_ERR_FAIL;
+ /* Flow control can only be enabled for both RTS & CTS together. */
+ if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
+ ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
+ RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
+ }
+
+ if (config->rts >= 0) {
+ if (config->rts == SP_RTS_FLOW_CONTROL) {
+ data->term.c_iflag |= CRTSCTS;
+ } else {
+ controlbits = TIOCM_RTS;
+ if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
+ &controlbits) < 0)
+ RETURN_FAIL("Setting RTS signal level failed");
+ }
}
}
-#endif
}
if (config->dtr >= 0 || config->dsr >= 0) {
-#ifdef USE_TERMIOX
- data->flow &= ~(DTR_FLOW | DSR_FLOW);
- switch (config->dtr) {
+ if (data->termiox_supported) {
+ data->flow &= ~(DTR_FLOW | DSR_FLOW);
+ switch (config->dtr) {
case SP_DTR_OFF:
case SP_DTR_ON:
controlbits = TIOCM_DTR;
- if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
- &controlbits) < 0)
- return SP_ERR_FAIL;
+ if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
+ RETURN_FAIL("Setting DTR signal level failed");
break;
case SP_DTR_FLOW_CONTROL:
data->flow |= DTR_FLOW;
break;
default:
break;
+ }
+ if (config->dsr == SP_DSR_FLOW_CONTROL)
+ data->flow |= DSR_FLOW;
+ } else {
+ /* DTR/DSR flow control not supported. */
+ if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
+ RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
+
+ if (config->dtr >= 0) {
+ controlbits = TIOCM_DTR;
+ if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
+ &controlbits) < 0)
+ RETURN_FAIL("Setting DTR signal level failed");
+ }
}
- if (config->dsr == SP_DSR_FLOW_CONTROL)
- data->flow |= DSR_FLOW;
-#else
- /* DTR/DSR flow control not supported. */
- if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
- return SP_ERR_ARG;
-
- if (config->dtr >= 0) {
- controlbits = TIOCM_DTR;
- if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
- &controlbits) < 0)
- return SP_ERR_FAIL;
- }
-#endif
}
if (config->xon_xoff >= 0) {
data->term.c_iflag |= IXON | IXOFF | IXANY;
break;
default:
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
}
}
if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("tcsetattr() failed");
#ifdef __APPLE__
if (baud_nonstd != B0) {
if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
- return SP_ERR_FAIL;
+ RETURN_FAIL("IOSSIOSPEED ioctl failed");
/* 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 SP_ERR_FAIL;
+ RETURN_FAIL("cfsetspeed() failed");
}
#elif defined(__linux__)
if (baud_nonstd)
TRY(set_baudrate(port->fd, config->baudrate));
#ifdef USE_TERMIOX
- TRY(set_flow(port->fd, data->flow));
+ if (data->termiox_supported)
+ TRY(set_flow(port->fd, data->flow));
#endif
#endif
#endif /* !_WIN32 */
- return SP_OK;
+ RETURN_OK();
+}
+
+enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config)
+{
+ struct port_data data;
+
+ TRACE("%p, %p", port, config);
+
+ CHECK_OPEN_PORT();
+
+ if (!config)
+ RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
+
+ TRY(get_config(port, &data, config));
+
+ RETURN_OK();
}
enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config)
struct port_data data;
struct sp_port_config prev_config;
- CHECK_PORT();
+ TRACE("%p, %p", port, config);
+
+ CHECK_OPEN_PORT();
if (!config)
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Null config");
TRY(get_config(port, &data, &prev_config));
TRY(set_config(port, &data, config));
- return SP_OK;
+ RETURN_OK();
}
#define CREATE_SETTER(x, type) int sp_set_##x(struct sp_port *port, type x) { \
struct port_data data; \
struct sp_port_config config; \
- CHECK_PORT(); \
+ TRACE("%p, %d", port, x); \
+ CHECK_OPEN_PORT(); \
TRY(get_config(port, &data, &config)); \
config.x = x; \
TRY(set_config(port, &data, &config)); \
- return SP_OK; \
+ RETURN_OK(); \
}
CREATE_SETTER(baudrate, int)
struct port_data data;
struct sp_port_config config;
- CHECK_PORT();
+ TRACE("%p, %d", port, flowcontrol);
+
+ CHECK_OPEN_PORT();
+
+ if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
+ RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
TRY(get_config(port, &data, &config));
TRY(set_config(port, &data, &config));
- return SP_OK;
+ RETURN_OK();
}
enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals)
{
- CHECK_PORT();
+ TRACE("%p, %p", port, signals);
+
+ CHECK_OPEN_PORT();
if (!signals)
- return SP_ERR_ARG;
+ RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
+
+ DEBUG("Getting control signals for port %s", port->name);
*signals = 0;
#ifdef _WIN32
DWORD bits;
if (GetCommModemStatus(port->hdl, &bits) == 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("GetCommModemStatus() failed");
if (bits & MS_CTS_ON)
*signals |= SP_SIG_CTS;
if (bits & MS_DSR_ON)
*signals |= SP_SIG_DSR;
- if (bits & MS_RING_ON)
- *signals |= SP_SIG_DCD;
if (bits & MS_RLSD_ON)
+ *signals |= SP_SIG_DCD;
+ if (bits & MS_RING_ON)
*signals |= SP_SIG_RI;
#else
int bits;
if (ioctl(port->fd, TIOCMGET, &bits) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("TIOCMGET ioctl failed");
if (bits & TIOCM_CTS)
*signals |= SP_SIG_CTS;
if (bits & TIOCM_DSR)
if (bits & TIOCM_RNG)
*signals |= SP_SIG_RI;
#endif
- return SP_OK;
+ RETURN_OK();
}
enum sp_return sp_start_break(struct sp_port *port)
{
- CHECK_PORT();
+ TRACE("%p", port);
+
+ CHECK_OPEN_PORT();
#ifdef _WIN32
if (SetCommBreak(port->hdl) == 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("SetCommBreak() failed");
#else
if (ioctl(port->fd, TIOCSBRK, 1) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("TIOCSBRK ioctl failed");
#endif
- return SP_OK;
+ RETURN_OK();
}
enum sp_return sp_end_break(struct sp_port *port)
{
- CHECK_PORT();
+ TRACE("%p", port);
+
+ CHECK_OPEN_PORT();
#ifdef _WIN32
if (ClearCommBreak(port->hdl) == 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("ClearCommBreak() failed");
#else
if (ioctl(port->fd, TIOCCBRK, 1) < 0)
- return SP_ERR_FAIL;
+ RETURN_FAIL("TIOCCBRK ioctl failed");
#endif
- return SP_OK;
+ RETURN_OK();
}
int sp_last_error_code(void)
{
+ TRACE("");
#ifdef _WIN32
- return GetLastError();
+ RETURN_VALUE("%d", GetLastError());
#else
- return errno;
+ RETURN_VALUE("%d", errno);
#endif
}
char *sp_last_error_message(void)
{
+ TRACE("");
+
#ifdef _WIN32
LPVOID message;
DWORD error = GetLastError();
(LPTSTR) &message,
0, NULL );
- return message;
+ RETURN_VALUE("%s", message);
#else
- return strerror(errno);
+ RETURN_VALUE("%s", strerror(errno));
#endif
}
void sp_free_error_message(char *message)
{
+ TRACE("%s", message);
+
#ifdef _WIN32
LocalFree(message);
#else
(void)message;
#endif
+
+ RETURN();
+}
+
+void sp_set_debug_handler(void (*handler)(const char *format, ...))
+{
+ TRACE("%p", handler);
+
+ sp_debug_handler = handler;
+
+ RETURN();
+}
+
+void sp_default_debug_handler(const char *format, ...)
+{
+ va_list args;
+ va_start(args, format);
+ if (getenv("LIBSERIALPORT_DEBUG")) {
+ fputs("libserialport: ", stderr);
+ vfprintf(stderr, format, args);
+ }
+ va_end(args);
}
projects / libserialport.git / blobdiff