#include "libserialport.h"
+struct sp_port {
+ char *name;
+#ifdef _WIN32
+ HANDLE hdl;
+#else
+ int fd;
+#endif
+};
+
struct port_data {
#ifdef _WIN32
DCB dcb;
#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 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 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,
if (!portname)
RETURN_ERROR(SP_ERR_ARG, "Null port name");
+ DEBUG("Building structure for port %s", portname);
+
if (!(port = malloc(sizeof(struct sp_port))))
RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
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 (!port->name)
RETURN_ERROR(SP_ERR_ARG, "Null port name");
+ DEBUG("Copying port structure");
+
RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr));
}
RETURN();
}
+ DEBUG("Freeing port structure");
+
if (port->name)
free(port->name);
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_ERROR(SP_ERR_MEM, "Port list malloc failed");
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) {
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) {
SET_FAIL(ret, "RegQueryInfoKey() failed");
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,
CFTypeRef cf_path;
Boolean result;
+ ret = SP_OK;
+
+ DEBUG("Getting IOKit master port");
if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) {
SET_FAIL(ret, "IOMasterPort() failed");
goto out_done;
}
+ DEBUG("Creating matching dictionary");
if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) {
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) {
SET_FAIL(ret, "IOServiceGetMatchingServices() failed");
goto out_done;
goto out_release;
}
+ DEBUG("Iterating over results");
while ((port = IOIteratorNext(iter))) {
cf_path = IORegistryEntryCreateCFProperty(port,
CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
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);
udev_unref(ud);
#endif
- if (ret == SP_OK) {
+ switch (ret) {
+ case SP_OK:
*list_ptr = list;
RETURN_OK();
- } else {
+ 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;
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();
}
-#ifdef _WIN32
#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
+#define CHECK_PORT_HANDLE() do { \
if (port->hdl == INVALID_HANDLE_VALUE) \
RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
-} while(0);
+} while (0)
#else
-#define CHECK_PORT() do { \
- if (port == NULL) \
- RETURN_ERROR(SP_ERR_ARG, "Null port"); \
+#define CHECK_PORT_HANDLE() do { \
if (port->fd < 0) \
RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
-} while(0);
+} while (0)
#endif
+#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)
{
TRACE("%p, %x", port, flags);
- if (!port)
- RETURN_ERROR(SP_ERR_ARG, "Null port");
+ 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;
{
TRACE("%p", port);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
+
+ DEBUG("Closing port %s", port->name);
#ifdef _WIN32
/* Returns non-zero upon success, 0 upon failure. */
{
TRACE("%p, %x", port, buffers);
- CHECK_PORT();
+ 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;
{
TRACE("%p", port);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
+
+ DEBUG("Draining port %s", port->name);
#ifdef _WIN32
/* Returns non-zero upon success, 0 upon failure. */
{
TRACE("%p, %p, %d", port, buf, count);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
if (!buf)
RETURN_ERROR(SP_ERR_ARG, "Null buffer");
+ DEBUG("Writing up to %d bytes to port %s", count, port->name);
+
#ifdef _WIN32
DWORD written = 0;
{
TRACE("%p, %p, %d", port, buf, count);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
if (!buf)
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;
TRACE("%d, %p", fd, baudrate);
+ DEBUG("Getting baud rate");
+
if (!(data = malloc(get_termios_size())))
RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
TRACE("%d, %d", fd, baudrate);
+ DEBUG("Getting baud rate");
+
if (!(data = malloc(get_termios_size())))
RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
RETURN_FAIL("getting termios failed");
}
+ DEBUG("Setting baud rate");
+
set_termios_speed(data, baudrate);
if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
TRACE("%d, %p", fd, flow);
+ DEBUG("Getting advanced flow control");
+
if (!(data = malloc(get_termiox_size())))
RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
TRACE("%d, %d", fd, flow);
+ DEBUG("Getting advanced flow control");
+
if (!(data = malloc(get_termiox_size())))
RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
RETURN_FAIL("getting termiox failed");
}
+ DEBUG("Setting advanced flow control");
+
set_termiox_flow(data, flow);
if (ioctl(fd, TCSETX, data) < 0) {
TRACE("%p, %p, %p", port, data, config);
+ DEBUG("Getting configuration for port %s", port->name);
+
#ifdef _WIN32
if (!GetCommState(port->hdl, &data->dcb))
RETURN_FAIL("GetCommState() failed");
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++) {
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;
TRACE("%p, %p", port, config);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
if (!config)
RETURN_ERROR(SP_ERR_ARG, "Null config");
struct port_data data; \
struct sp_port_config config; \
TRACE("%p, %d", port, x); \
- CHECK_PORT(); \
+ CHECK_OPEN_PORT(); \
TRY(get_config(port, &data, &config)); \
config.x = x; \
TRY(set_config(port, &data, &config)); \
TRACE("%p, %d", port, flowcontrol);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
+
+ if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
+ RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
TRY(get_config(port, &data, &config));
{
TRACE("%p, %p", port, signals);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
if (!signals)
RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
+ DEBUG("Getting control signals for port %s", port->name);
+
*signals = 0;
#ifdef _WIN32
DWORD bits;
*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;
{
TRACE("%p", port);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
#ifdef _WIN32
if (SetCommBreak(port->hdl) == 0)
RETURN_FAIL("SetCommBreak() failed");
{
TRACE("%p", port);
- CHECK_PORT();
+ CHECK_OPEN_PORT();
#ifdef _WIN32
if (ClearCommBreak(port->hdl) == 0)
RETURN_FAIL("ClearCommBreak() failed");
projects / libserialport.git / blobdiff