* Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
* Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
* Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
+ * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
#include <stdarg.h>
#ifdef _WIN32
#include <windows.h>
+#include <setupapi.h>
+#include <cfgmgr32.h>
+#include <usbioctl.h>
#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 <CoreFoundation/CoreFoundation.h>
#include <IOKit/IOKitLib.h>
#include <IOKit/serial/IOSerialKeys.h>
#include <IOKit/serial/ioss.h>
#include <sys/syslimits.h>
#endif
#ifdef __linux__
-#include "libudev.h"
+#include <dirent.h>
+#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;
+ char *description;
+ enum sp_transport transport;
+ int usb_bus;
+ int usb_address;
+ int usb_vid;
+ int usb_pid;
+ char *usb_manufacturer;
+ char *usb_product;
+ char *usb_serial;
+ char *bluetooth_address;
#ifdef _WIN32
+ char *usb_path;
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__)
#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,
struct sp_port_config *config);
static enum sp_return set_config(struct sp_port *port, struct port_data *data,
const struct sp_port_config *config);
+#ifdef _WIN32
+
+/* USB path is a string of at most 8 decimal numbers < 128 separated by dots */
+#define MAX_USB_PATH (8*3 + 7*1 + 1)
+
+static char *wc_to_utf8(PWCHAR wc_buffer, ULONG size)
+{
+ WCHAR wc_str[size/sizeof(WCHAR)+1];
+ char *utf8_str;
+
+ /* zero terminate the wide char string */
+ memcpy(wc_str, wc_buffer, size);
+ wc_str[sizeof(wc_str)-1] = 0;
+
+ /* compute the size of the utf8 converted string */
+ if (!(size = WideCharToMultiByte(CP_ACP, WC_NO_BEST_FIT_CHARS, wc_str, -1,
+ NULL, 0, NULL, NULL)))
+ return NULL;
+
+ /* allocate utf8 output buffer */
+ if (!(utf8_str = malloc(size)))
+ return NULL;
+
+ /* actually converted to utf8 */
+ if (!WideCharToMultiByte(CP_ACP, WC_NO_BEST_FIT_CHARS, wc_str, -1,
+ utf8_str, size, NULL, NULL)) {
+ free(utf8_str);
+ return NULL;
+ }
+
+ return utf8_str;
+}
+
+static char *get_root_hub_name(HANDLE host_controller)
+{
+ USB_ROOT_HUB_NAME root_hub_name;
+ PUSB_ROOT_HUB_NAME root_hub_name_wc;
+ char *root_hub_name_utf8;
+ ULONG size = 0;
+
+ /* compute the size of the root hub name string */
+ if (!DeviceIoControl(host_controller, IOCTL_USB_GET_ROOT_HUB_NAME, 0, 0,
+ &root_hub_name, sizeof(root_hub_name), &size, NULL))
+ return NULL;
+
+ /* allocate wide char root hub name string */
+ size = root_hub_name.ActualLength;
+ if (!(root_hub_name_wc = malloc(size)))
+ return NULL;
+
+ /* actually get the root hub name string */
+ if (!DeviceIoControl(host_controller, IOCTL_USB_GET_ROOT_HUB_NAME,
+ NULL, 0, root_hub_name_wc, size, &size, NULL)) {
+ free(root_hub_name_wc);
+ return NULL;
+ }
+
+ /* convert the root hub name string to utf8 */
+ root_hub_name_utf8 = wc_to_utf8(root_hub_name_wc->RootHubName, size);
+ free(root_hub_name_wc);
+ return root_hub_name_utf8;
+}
+
+static char *get_external_hub_name(HANDLE hub, ULONG connection_index)
+{
+ USB_NODE_CONNECTION_NAME ext_hub_name;
+ PUSB_NODE_CONNECTION_NAME ext_hub_name_wc;
+ char *ext_hub_name_utf8;
+ ULONG size;
+
+ /* compute the size of the external hub name string */
+ ext_hub_name.ConnectionIndex = connection_index;
+ if (!DeviceIoControl(hub, IOCTL_USB_GET_NODE_CONNECTION_NAME,
+ &ext_hub_name, sizeof(ext_hub_name),
+ &ext_hub_name, sizeof(ext_hub_name), &size, NULL))
+ return NULL;
+
+ /* allocate wide char external hub name string */
+ size = ext_hub_name.ActualLength;
+ if (size <= sizeof(ext_hub_name)
+ || !(ext_hub_name_wc = malloc(size)))
+ return NULL;
+
+ /* get the name of the external hub attached to the specified port */
+ ext_hub_name_wc->ConnectionIndex = connection_index;
+ if (!DeviceIoControl(hub, IOCTL_USB_GET_NODE_CONNECTION_NAME,
+ ext_hub_name_wc, size,
+ ext_hub_name_wc, size, &size, NULL)) {
+ free(ext_hub_name_wc);
+ return NULL;
+ }
+
+ /* convert the external hub name string to utf8 */
+ ext_hub_name_utf8 = wc_to_utf8(ext_hub_name_wc->NodeName, size);
+ free(ext_hub_name_wc);
+ return ext_hub_name_utf8;
+}
+
+static char *get_string_descriptor(HANDLE hub_device, ULONG connection_index,
+ UCHAR descriptor_index)
+{
+ char desc_req_buf[sizeof(USB_DESCRIPTOR_REQUEST) +
+ MAXIMUM_USB_STRING_LENGTH] = { 0 };
+ PUSB_DESCRIPTOR_REQUEST desc_req = (void *) desc_req_buf;
+ PUSB_STRING_DESCRIPTOR desc = (void *) (desc_req + 1);
+ ULONG size = sizeof(desc_req_buf);
+
+ desc_req->ConnectionIndex = connection_index;
+ desc_req->SetupPacket.wValue = (USB_STRING_DESCRIPTOR_TYPE << 8)
+ | descriptor_index;
+ desc_req->SetupPacket.wIndex = 0;
+ desc_req->SetupPacket.wLength = size - sizeof(*desc_req);
+
+ if (!DeviceIoControl(hub_device,
+ IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION,
+ desc_req, size, desc_req, size, &size, NULL)
+ || size < 2
+ || desc->bDescriptorType != USB_STRING_DESCRIPTOR_TYPE
+ || desc->bLength != size - sizeof(*desc_req)
+ || desc->bLength % 2)
+ return NULL;
+
+ return wc_to_utf8(desc->bString, desc->bLength);
+}
+
+static void enumerate_hub(struct sp_port *port, char *hub_name,
+ char *parent_path);
+
+static void enumerate_hub_ports(struct sp_port *port, HANDLE hub_device,
+ ULONG nb_ports, char *parent_path)
+{
+ char path[MAX_USB_PATH];
+ ULONG index = 0;
+
+ for (index = 1; index <= nb_ports; index++) {
+ PUSB_NODE_CONNECTION_INFORMATION_EX connection_info_ex;
+ ULONG size = sizeof(*connection_info_ex) + 30*sizeof(USB_PIPE_INFO);
+
+ if (!(connection_info_ex = malloc(size)))
+ break;
+
+ connection_info_ex->ConnectionIndex = index;
+ if (!DeviceIoControl(hub_device,
+ IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX,
+ connection_info_ex, size,
+ connection_info_ex, size, &size, NULL)) {
+ /* try to get CONNECTION_INFORMATION if CONNECTION_INFORMATION_EX
+ did not work */
+ PUSB_NODE_CONNECTION_INFORMATION connection_info;
+
+ size = sizeof(*connection_info) + 30*sizeof(USB_PIPE_INFO);
+ if (!(connection_info = malloc(size))) {
+ free(connection_info_ex);
+ continue;
+ }
+ connection_info->ConnectionIndex = index;
+ if (!DeviceIoControl(hub_device,
+ IOCTL_USB_GET_NODE_CONNECTION_INFORMATION,
+ connection_info, size,
+ connection_info, size, &size, NULL)) {
+ free(connection_info);
+ free(connection_info_ex);
+ continue;
+ }
+
+ connection_info_ex->ConnectionIndex = connection_info->ConnectionIndex;
+ connection_info_ex->DeviceDescriptor = connection_info->DeviceDescriptor;
+ connection_info_ex->DeviceIsHub = connection_info->DeviceIsHub;
+ connection_info_ex->DeviceAddress = connection_info->DeviceAddress;
+ free(connection_info);
+ }
+
+ if (connection_info_ex->DeviceIsHub) {
+ /* recursively enumerate external hub */
+ PCHAR ext_hub_name;
+ if ((ext_hub_name = get_external_hub_name(hub_device, index))) {
+ snprintf(path, sizeof(path), "%s%d.",
+ parent_path, connection_info_ex->ConnectionIndex);
+ enumerate_hub(port, ext_hub_name, path);
+ }
+ free(connection_info_ex);
+ } else {
+ snprintf(path, sizeof(path), "%s%d",
+ parent_path, connection_info_ex->ConnectionIndex);
+
+ /* check if this device is the one we search for */
+ if (strcmp(path, port->usb_path)) {
+ free(connection_info_ex);
+ continue;
+ }
+
+ /* finally grab detailed informations regarding the device */
+ port->usb_address = connection_info_ex->DeviceAddress + 1;
+ port->usb_vid = connection_info_ex->DeviceDescriptor.idVendor;
+ port->usb_pid = connection_info_ex->DeviceDescriptor.idProduct;
+
+ if (connection_info_ex->DeviceDescriptor.iManufacturer)
+ port->usb_manufacturer = get_string_descriptor(hub_device,index,
+ connection_info_ex->DeviceDescriptor.iManufacturer);
+ if (connection_info_ex->DeviceDescriptor.iProduct)
+ port->usb_product = get_string_descriptor(hub_device, index,
+ connection_info_ex->DeviceDescriptor.iProduct);
+ if (connection_info_ex->DeviceDescriptor.iSerialNumber)
+ port->usb_serial = get_string_descriptor(hub_device, index,
+ connection_info_ex->DeviceDescriptor.iSerialNumber);
+
+ free(connection_info_ex);
+ break;
+ }
+ }
+}
+
+static void enumerate_hub(struct sp_port *port, char *hub_name,
+ char *parent_path)
+{
+ USB_NODE_INFORMATION hub_info;
+ HANDLE hub_device;
+ ULONG size = sizeof(hub_info);
+ char *device_name;
+
+ /* open the hub with its full name */
+ if (!(device_name = malloc(strlen("\\\\.\\") + strlen(hub_name) + 1)))
+ return;
+ strcpy(device_name, "\\\\.\\");
+ strcat(device_name, hub_name);
+ hub_device = CreateFile(device_name, GENERIC_WRITE, FILE_SHARE_WRITE,
+ NULL, OPEN_EXISTING, 0, NULL);
+ free(device_name);
+ if (hub_device == INVALID_HANDLE_VALUE)
+ return;
+
+ /* get the number of ports of the hub */
+ if (DeviceIoControl(hub_device, IOCTL_USB_GET_NODE_INFORMATION,
+ &hub_info, size, &hub_info, size, &size, NULL))
+ /* enumarate the ports of the hub */
+ enumerate_hub_ports(port, hub_device,
+ hub_info.u.HubInformation.HubDescriptor.bNumberOfPorts, parent_path);
+
+ CloseHandle(hub_device);
+}
+
+static void enumerate_host_controller(struct sp_port *port,
+ HANDLE host_controller_device)
+{
+ char *root_hub_name;
+
+ if ((root_hub_name = get_root_hub_name(host_controller_device))) {
+ enumerate_hub(port, root_hub_name, "");
+ free(root_hub_name);
+ }
+}
+
+static void get_usb_details(struct sp_port *port, DEVINST dev_inst_match)
+{
+ HDEVINFO device_info;
+ SP_DEVINFO_DATA device_info_data;
+ ULONG i, size = 0;
+
+ device_info = SetupDiGetClassDevs(&GUID_CLASS_USB_HOST_CONTROLLER,NULL,NULL,
+ DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
+ device_info_data.cbSize = sizeof(device_info_data);
+
+ for (i=0; SetupDiEnumDeviceInfo(device_info, i, &device_info_data); i++) {
+ SP_DEVICE_INTERFACE_DATA device_interface_data;
+ PSP_DEVICE_INTERFACE_DETAIL_DATA device_detail_data;
+ DEVINST dev_inst = dev_inst_match;
+ HANDLE host_controller_device;
+
+ device_interface_data.cbSize = sizeof(device_interface_data);
+ if (!SetupDiEnumDeviceInterfaces(device_info, 0,
+ &GUID_CLASS_USB_HOST_CONTROLLER,
+ i, &device_interface_data))
+ continue;
+
+ if (!SetupDiGetDeviceInterfaceDetail(device_info,&device_interface_data,
+ NULL, 0, &size, NULL)
+ && GetLastError() != ERROR_INSUFFICIENT_BUFFER)
+ continue;
+
+ if (!(device_detail_data = malloc(size)))
+ continue;
+ device_detail_data->cbSize = sizeof(*device_detail_data);
+ if (!SetupDiGetDeviceInterfaceDetail(device_info,&device_interface_data,
+ device_detail_data, size, &size,
+ NULL)) {
+ free(device_detail_data);
+ continue;
+ }
+
+ while (CM_Get_Parent(&dev_inst, dev_inst, 0) == CR_SUCCESS
+ && dev_inst != device_info_data.DevInst) { }
+ if (dev_inst != device_info_data.DevInst) {
+ free(device_detail_data);
+ continue;
+ }
+
+ port->usb_bus = i + 1;
+
+ host_controller_device = CreateFile(device_detail_data->DevicePath,
+ GENERIC_WRITE, FILE_SHARE_WRITE,
+ NULL, OPEN_EXISTING, 0, NULL);
+ if (host_controller_device != INVALID_HANDLE_VALUE) {
+ enumerate_host_controller(port, host_controller_device);
+ CloseHandle(host_controller_device);
+ }
+ free(device_detail_data);
+ }
+
+ SetupDiDestroyDeviceInfoList(device_info);
+ return;
+}
+
+#endif /* _WIN32 */
+
+static enum sp_return sp_get_port_details(struct sp_port *port)
+{
+ /* Description limited to 127 char,
+ anything longer would not be user friendly anyway */
+ char description[128];
+#ifndef _WIN32
+ int bus, address, vid, pid = -1;
+ char manufacturer[128], product[128], serial[128];
+ char baddr[32];
+#endif
+
+ port->description = NULL;
+ port->transport = SP_TRANSPORT_NATIVE;
+ port->usb_bus = -1;
+ port->usb_address = -1;
+ port->usb_vid = -1;
+ port->usb_pid = -1;
+ port->usb_manufacturer = NULL;
+ port->usb_product = NULL;
+ port->usb_serial = NULL;
+ port->bluetooth_address = NULL;
+
+#ifdef _WIN32
+ SP_DEVINFO_DATA device_info_data = { .cbSize = sizeof(device_info_data) };
+ HDEVINFO device_info;
+ int i;
+
+ device_info = SetupDiGetClassDevs(NULL, 0, 0,
+ DIGCF_PRESENT | DIGCF_ALLCLASSES);
+ if (device_info == INVALID_HANDLE_VALUE)
+ RETURN_FAIL("SetupDiGetClassDevs() failed");
+
+ for (i=0; SetupDiEnumDeviceInfo(device_info, i, &device_info_data); i++) {
+ HKEY device_key;
+ DEVINST dev_inst;
+ char value[8], class[16];
+ DWORD size, type;
+ CONFIGRET cr;
+
+ /* check if this is the device we are looking for */
+ if (!(device_key = SetupDiOpenDevRegKey(device_info, &device_info_data,
+ DICS_FLAG_GLOBAL, 0,
+ DIREG_DEV, KEY_QUERY_VALUE)))
+ continue;
+ size = sizeof(value);
+ if (RegQueryValueExA(device_key, "PortName", NULL, &type, (LPBYTE)value,
+ &size) != ERROR_SUCCESS || type != REG_SZ)
+ continue;
+ RegCloseKey(device_key);
+ value[sizeof(value)-1] = 0;
+ if (strcmp(value, port->name))
+ continue;
+
+ /* check port transport type */
+ dev_inst = device_info_data.DevInst;
+ size = sizeof(class);
+ cr = CR_FAILURE;
+ while (CM_Get_Parent(&dev_inst, dev_inst, 0) == CR_SUCCESS &&
+ (cr = CM_Get_DevNode_Registry_PropertyA(dev_inst,
+ CM_DRP_CLASS, 0, class, &size, 0)) != CR_SUCCESS) { }
+ if (cr == CR_SUCCESS) {
+ if (!strcmp(class, "USB"))
+ port->transport = SP_TRANSPORT_USB;
+ }
+
+ /* get port description (friendly name) */
+ dev_inst = device_info_data.DevInst;
+ size = sizeof(description);
+ while ((cr = CM_Get_DevNode_Registry_PropertyA(dev_inst,
+ CM_DRP_FRIENDLYNAME, 0, description, &size, 0)) != CR_SUCCESS
+ && CM_Get_Parent(&dev_inst, dev_inst, 0) == CR_SUCCESS) { }
+ if (cr == CR_SUCCESS)
+ port->description = strdup(description);
+
+ /* get more informations for USB connected ports */
+ if (port->transport == SP_TRANSPORT_USB) {
+ char usb_path[MAX_USB_PATH] = "", tmp[MAX_USB_PATH];
+ char device_id[MAX_DEVICE_ID_LEN];
+
+ /* recurse over parents to build the USB device path */
+ dev_inst = device_info_data.DevInst;
+ do {
+ /* verify that this layer of the tree is USB related */
+ if (CM_Get_Device_IDA(dev_inst, device_id,
+ sizeof(device_id), 0) != CR_SUCCESS
+ || strncmp(device_id, "USB\\", 4))
+ continue;
+
+ /* discard one layer for composite devices */
+ char compat_ids[512], *p = compat_ids;
+ size = sizeof(compat_ids);
+ if (CM_Get_DevNode_Registry_PropertyA(dev_inst,
+ CM_DRP_COMPATIBLEIDS, 0,
+ &compat_ids,
+ &size, 0) == CR_SUCCESS) {
+ while (*p) {
+ if (!strncmp(p, "USB\\COMPOSITE", 13))
+ break;
+ p += strlen(p) + 1;
+ }
+ if (*p)
+ continue;
+ }
+
+ /* stop the recursion when reaching the USB root */
+ if (!strncmp(device_id, "USB\\ROOT", 8))
+ break;
+
+ /* prepend the address of current USB layer to the USB path */
+ DWORD address;
+ size = sizeof(address);
+ if (CM_Get_DevNode_Registry_PropertyA(dev_inst, CM_DRP_ADDRESS,
+ 0, &address, &size, 0) == CR_SUCCESS) {
+ strcpy(tmp, usb_path);
+ snprintf(usb_path, sizeof(usb_path), "%d%s%s",
+ (int)address, *tmp ? "." : "", tmp);
+ }
+ } while (CM_Get_Parent(&dev_inst, dev_inst, 0) == CR_SUCCESS);
+
+ port->usb_path = strdup(usb_path);
+
+ /* wake up the USB device to be able to read string descriptor */
+ char *escaped_port_name;
+ HANDLE handle;
+ 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);
+ handle = CreateFile(escaped_port_name, GENERIC_READ, 0, 0,
+ OPEN_EXISTING,
+ FILE_ATTRIBUTE_NORMAL|FILE_FLAG_OVERLAPPED, 0);
+ free(escaped_port_name);
+ CloseHandle(handle);
+
+ /* retrive USB device details from the device descriptor */
+ get_usb_details(port, device_info_data.DevInst);
+ }
+ break;
+ }
+#elif defined(__APPLE__)
+ CFMutableDictionaryRef classes;
+ io_iterator_t iter;
+ io_object_t ioport;
+ CFTypeRef cf_property, cf_bus, cf_address, cf_vendor, cf_product;
+ Boolean result;
+ char path[PATH_MAX];
+
+ DEBUG("Getting serial port list");
+ if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue)))
+ RETURN_FAIL("IOServiceMatching() failed");
+
+ if (IOServiceGetMatchingServices(kIOMasterPortDefault, classes,
+ &iter) != KERN_SUCCESS)
+ RETURN_FAIL("IOServiceGetMatchingServices() failed");
+
+ DEBUG("Iterating over results");
+ while ((ioport = IOIteratorNext(iter))) {
+ if (!(cf_property = IORegistryEntryCreateCFProperty(ioport,
+ CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0))) {
+ IOObjectRelease(ioport);
+ continue;
+ }
+ result = CFStringGetCString(cf_property, path, sizeof(path),
+ kCFStringEncodingASCII);
+ CFRelease(cf_property);
+ if (!result || strcmp(path, port->name)) {
+ IOObjectRelease(ioport);
+ continue;
+ }
+ DEBUG("Found port %s", path);
+
+ IORegistryEntryGetParentEntry(ioport, kIOServicePlane, &ioparent);
+ if ((cf_property=IORegistryEntrySearchCFProperty(ioparent,kIOServicePlane,
+ CFSTR("IOProviderClass"), kCFAllocatorDefault,
+ kIORegistryIterateRecursively | kIORegistryIterateParents))) {
+ if (CFStringGetCString(cf_property, class, sizeof(class),
+ kCFStringEncodingASCII) &&
+ strstr(class, "USB")) {
+ DEBUG("Found USB class device");
+ port->transport = SP_TRANSPORT_USB;
+ }
+ CFRelease(cf_property);
+ }
+ IOObjectRelease(ioparent);
+
+ if ((cf_property = IORegistryEntrySearchCFProperty(ioport,kIOServicePlane,
+ CFSTR("USB Interface Name"), kCFAllocatorDefault,
+ kIORegistryIterateRecursively | kIORegistryIterateParents)) ||
+ (cf_property = IORegistryEntrySearchCFProperty(ioport,kIOServicePlane,
+ CFSTR("USB Product Name"), kCFAllocatorDefault,
+ kIORegistryIterateRecursively | kIORegistryIterateParents)) ||
+ (cf_property = IORegistryEntrySearchCFProperty(ioport,kIOServicePlane,
+ CFSTR("Product Name"), kCFAllocatorDefault,
+ kIORegistryIterateRecursively | kIORegistryIterateParents)) ||
+ (cf_property = IORegistryEntryCreateCFProperty(ioport,
+ CFSTR(kIOTTYDeviceKey), kCFAllocatorDefault, 0))) {
+ if (CFStringGetCString(cf_property, description, sizeof(description),
+ kCFStringEncodingASCII)) {
+ DEBUG("Found description %s", description);
+ port->description = strdup(description);
+ }
+ CFRelease(cf_property);
+ } else {
+ DEBUG("No description for this device");
+ }
+
+ cf_bus = IORegistryEntrySearchCFProperty(ioport, kIOServicePlane,
+ CFSTR("USBBusNumber"),
+ kCFAllocatorDefault,
+ kIORegistryIterateRecursively
+ | kIORegistryIterateParents);
+ cf_address = IORegistryEntrySearchCFProperty(ioport, kIOServicePlane,
+ CFSTR("USB Address"),
+ kCFAllocatorDefault,
+ kIORegistryIterateRecursively
+ | kIORegistryIterateParents);
+ if (cf_bus && cf_address &&
+ CFNumberGetValue(cf_bus , kCFNumberIntType, &bus) &&
+ CFNumberGetValue(cf_address, kCFNumberIntType, &address)) {
+ DEBUG("Found matching USB bus:address %03d:%03d", bus, address);
+ port->usb_bus = bus;
+ port->usb_address = address;
+ }
+ if (cf_bus ) CFRelease(cf_bus);
+ if (cf_address) CFRelease(cf_address);
+
+ cf_vendor = IORegistryEntrySearchCFProperty(ioport, kIOServicePlane,
+ CFSTR("idVendor"),
+ kCFAllocatorDefault,
+ kIORegistryIterateRecursively
+ | kIORegistryIterateParents);
+ cf_product = IORegistryEntrySearchCFProperty(ioport, kIOServicePlane,
+ CFSTR("idProduct"),
+ kCFAllocatorDefault,
+ kIORegistryIterateRecursively
+ | kIORegistryIterateParents);
+ if (cf_vendor && cf_product &&
+ CFNumberGetValue(cf_vendor , kCFNumberIntType, &vid) &&
+ CFNumberGetValue(cf_product, kCFNumberIntType, &pid)) {
+ DEBUG("Found matching USB vid:pid %04X:%04X", vid, pid);
+ port->usb_vid = vid;
+ port->usb_pid = pid;
+ }
+ if (cf_vendor ) CFRelease(cf_vendor);
+ if (cf_product) CFRelease(cf_product);
+
+ if ((cf_property = IORegistryEntrySearchCFProperty(ioport,kIOServicePlane,
+ CFSTR("USB Vendor Name"), kCFAllocatorDefault,
+ kIORegistryIterateRecursively | kIORegistryIterateParents))) {
+ if (CFStringGetCString(cf_property, manufacturer, sizeof(manufacturer),
+ kCFStringEncodingASCII)) {
+ DEBUG("Found manufacturer %s", manufacturer);
+ port->usb_manufacturer = strdup(manufacturer);
+ }
+ CFRelease(cf_property);
+ }
+
+ if ((cf_property = IORegistryEntrySearchCFProperty(ioport,kIOServicePlane,
+ CFSTR("USB Product Name"), kCFAllocatorDefault,
+ kIORegistryIterateRecursively | kIORegistryIterateParents))) {
+ if (CFStringGetCString(cf_property, product, sizeof(product),
+ kCFStringEncodingASCII)) {
+ DEBUG("Found product name %s", product);
+ port->usb_product = strdup(product);
+ }
+ CFRelease(cf_property);
+ }
+
+ if ((cf_property = IORegistryEntrySearchCFProperty(ioport,kIOServicePlane,
+ CFSTR("USB Serial Number"), kCFAllocatorDefault,
+ kIORegistryIterateRecursively | kIORegistryIterateParents))) {
+ if (CFStringGetCString(cf_property, serial, sizeof(serial),
+ kCFStringEncodingASCII)) {
+ DEBUG("Found serial number %s", serial);
+ port->usb_serial = strdup(serial);
+ }
+ CFRelease(cf_property);
+ }
+
+ IOObjectRelease(ioport);
+ break;
+ }
+ IOObjectRelease(iter);
+#elif defined(__linux__)
+ const char dir_name[] = "/sys/class/tty/%s/device/%s%s";
+ char sub_dir[32] = "", file_name[PATH_MAX];
+ char *ptr, *dev = port->name + 5;
+ FILE *file;
+ int i, count;
+
+ if (strncmp(port->name, "/dev/", 5))
+ RETURN_ERROR(SP_ERR_ARG, "Device name not recognized (%s)", port->name);
+
+ snprintf(file_name, sizeof(file_name), "/sys/class/tty/%s", dev);
+ count = readlink(file_name, file_name, sizeof(file_name));
+ if (count <= 0 || count >= (int) sizeof(file_name)-1)
+ RETURN_ERROR(SP_ERR_ARG, "Device not found (%s)", port->name);
+ file_name[count] = 0;
+ if (strstr(file_name, "bluetooth"))
+ port->transport = SP_TRANSPORT_BLUETOOTH;
+ else if (strstr(file_name, "usb"))
+ port->transport = SP_TRANSPORT_USB;
+
+ if (port->transport == SP_TRANSPORT_USB) {
+ for (i=0; i<5; i++) {
+ strcat(sub_dir, "../");
+
+ snprintf(file_name,sizeof(file_name),dir_name,dev,sub_dir,"busnum");
+ if (!(file = fopen(file_name, "r")))
+ continue;
+ count = fscanf(file, "%d", &bus);
+ fclose(file);
+ if (count != 1)
+ continue;
+
+ snprintf(file_name,sizeof(file_name),dir_name,dev,sub_dir,"devnum");
+ if (!(file = fopen(file_name, "r")))
+ continue;
+ count = fscanf(file, "%d", &address);
+ fclose(file);
+ if (count != 1)
+ continue;
+
+ snprintf(file_name,sizeof(file_name),dir_name,dev,sub_dir,"idVendor");
+ if (!(file = fopen(file_name, "r")))
+ continue;
+ count = fscanf(file, "%4x", &vid);
+ fclose(file);
+ if (count != 1)
+ continue;
+
+ snprintf(file_name,sizeof(file_name),dir_name,dev,sub_dir,"idProduct");
+ if (!(file = fopen(file_name, "r")))
+ continue;
+ count = fscanf(file, "%4x", &pid);
+ fclose(file);
+ if (count != 1)
+ continue;
+
+ port->usb_bus = bus;
+ port->usb_address = address;
+ port->usb_vid = vid;
+ port->usb_pid = pid;
+
+ snprintf(file_name,sizeof(file_name),dir_name,dev,sub_dir,"product");
+ if ((file = fopen(file_name, "r"))) {
+ if ((ptr = fgets(description, sizeof(description), file))) {
+ ptr = description + strlen(description) - 1;
+ if (ptr >= description && *ptr == '\n')
+ *ptr = 0;
+ port->description = strdup(description);
+ }
+ fclose(file);
+ }
+ if (!file || !ptr)
+ port->description = strdup(dev);
+
+ snprintf(file_name,sizeof(file_name),dir_name,dev,sub_dir,"manufacturer");
+ if ((file = fopen(file_name, "r"))) {
+ if ((ptr = fgets(manufacturer, sizeof(manufacturer), file))) {
+ ptr = manufacturer + strlen(manufacturer) - 1;
+ if (ptr >= manufacturer && *ptr == '\n')
+ *ptr = 0;
+ port->usb_manufacturer = strdup(manufacturer);
+ }
+ fclose(file);
+ }
+
+ snprintf(file_name,sizeof(file_name),dir_name,dev,sub_dir,"product");
+ if ((file = fopen(file_name, "r"))) {
+ if ((ptr = fgets(product, sizeof(product), file))) {
+ ptr = product + strlen(product) - 1;
+ if (ptr >= product && *ptr == '\n')
+ *ptr = 0;
+ port->usb_product = strdup(product);
+ }
+ fclose(file);
+ }
+
+ snprintf(file_name,sizeof(file_name),dir_name,dev,sub_dir,"serial");
+ if ((file = fopen(file_name, "r"))) {
+ if ((ptr = fgets(serial, sizeof(serial), file))) {
+ ptr = serial + strlen(serial) - 1;
+ if (ptr >= serial && *ptr == '\n')
+ *ptr = 0;
+ port->usb_serial = strdup(serial);
+ }
+ fclose(file);
+ }
+
+ break;
+ }
+ } else {
+ port->description = strdup(dev);
+
+ if (port->transport == SP_TRANSPORT_BLUETOOTH) {
+ snprintf(file_name, sizeof(file_name), dir_name, dev, "", "address");
+ if ((file = fopen(file_name, "r"))) {
+ if ((ptr = fgets(baddr, sizeof(baddr), file))) {
+ ptr = baddr + strlen(baddr) - 1;
+ if (ptr >= baddr && *ptr == '\n')
+ *ptr = 0;
+ port->bluetooth_address = strdup(baddr);
+ }
+ fclose(file);
+ }
+ }
+ }
+#else
+ DEBUG("Port details not supported on this platform");
+#endif
+
+ RETURN_OK();
+}
+
enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
{
struct sp_port *port;
+ enum sp_return ret;
int len;
TRACE("%s, %p", portname, port_ptr);
port->fd = -1;
#endif
+ if ((ret = sp_get_port_details(port)) != SP_OK) {
+ sp_free_port(port);
+ return ret;
+ }
+
*port_ptr = port;
RETURN_OK();
RETURN_VALUE("%s", port->name);
}
+char *sp_get_port_description(struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ if (!port || !port->description)
+ return NULL;
+
+ RETURN_VALUE("%s", port->description);
+}
+
+enum sp_transport sp_get_port_transport(struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ if (!port)
+ RETURN_ERROR(SP_ERR_ARG, "Null port");
+
+ RETURN_VALUE("%d", port->transport);
+}
+
+enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
+ int *usb_bus, int *usb_address)
+{
+ TRACE("%p", port);
+
+ if (!port)
+ RETURN_ERROR(SP_ERR_ARG, "Null port");
+ if (port->transport != SP_TRANSPORT_USB)
+ RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
+
+ if (usb_bus) *usb_bus = port->usb_bus;
+ if (usb_address) *usb_address = port->usb_address;
+
+ RETURN_OK();
+}
+
+enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
+ int *usb_vid, int *usb_pid)
+{
+ TRACE("%p", port);
+
+ if (!port)
+ RETURN_ERROR(SP_ERR_ARG, "Null port");
+ if (port->transport != SP_TRANSPORT_USB)
+ RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
+
+ if (usb_vid) *usb_vid = port->usb_vid;
+ if (usb_pid) *usb_pid = port->usb_pid;
+
+ RETURN_OK();
+}
+
+char *sp_get_port_usb_manufacturer(const struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
+ return NULL;
+
+ RETURN_VALUE("%s", port->usb_manufacturer);
+}
+
+char *sp_get_port_usb_product(const struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
+ return NULL;
+
+ RETURN_VALUE("%s", port->usb_product);
+}
+
+char *sp_get_port_usb_serial(const struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
+ return NULL;
+
+ RETURN_VALUE("%s", port->usb_serial);
+}
+
+char *sp_get_port_bluetooth_address(const struct sp_port *port)
+{
+ TRACE("%p", port);
+
+ if (!port || port->transport != SP_TRANSPORT_BLUETOOTH
+ || !port->bluetooth_address)
+ return NULL;
+
+ RETURN_VALUE("%s", port->bluetooth_address);
+}
+
enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr)
{
TRACE("%p, %p", port, result_ptr);
if (port->name)
free(port->name);
+ if (port->description)
+ free(port->description);
+ if (port->usb_manufacturer)
+ free(port->usb_manufacturer);
+ if (port->usb_product)
+ free(port->usb_product);
+ if (port->usb_serial)
+ free(port->usb_serial);
+ if (port->bluetooth_address)
+ free(port->bluetooth_address);
+#ifdef _WIN32
+ if (port->usb_path)
+ free(port->usb_path);
+#endif
free(port);
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
out_done:
#endif
#ifdef __APPLE__
- mach_port_t master;
CFMutableDictionaryRef classes;
io_iterator_t iter;
- char *path;
+ char path[PATH_MAX];
io_object_t port;
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) {
+ if (IOServiceGetMatchingServices(kIOMasterPortDefault, classes,
+ &iter) != KERN_SUCCESS) {
SET_FAIL(ret, "IOServiceGetMatchingServices() failed");
goto out_done;
}
- if (!(path = malloc(PATH_MAX))) {
- 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);
if (cf_path) {
- result = CFStringGetCString(cf_path,
- path, PATH_MAX, kCFStringEncodingASCII);
+ result = CFStringGetCString(cf_path, path, sizeof(path),
+ kCFStringEncodingASCII);
CFRelease(cf_path);
if (result) {
DEBUG("Found port %s", path);
IOObjectRelease(port);
}
out:
- free(path);
-out_release:
IOObjectRelease(iter);
out_done:
#endif
#ifdef __linux__
- struct udev *ud;
- struct udev_enumerate *ud_enumerate;
- struct udev_list_entry *ud_list;
- struct udev_list_entry *ud_entry;
- const char *path;
- struct udev_device *ud_dev, *ud_parent;
- const char *name;
- const char *driver;
- int fd, ioctl_result;
+ char name[PATH_MAX], target[PATH_MAX];
+ struct dirent entry, *result;
struct serial_struct serial_info;
+ int len, fd, ioctl_result;
+ DIR *dir;
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);
+ if (!(dir = opendir("/sys/class/tty")))
+ RETURN_FAIL("could not open /sys/class/tty");
+
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);
+ while (!readdir_r(dir, &entry, &result) && result) {
+ len = readlinkat(dirfd(dir), entry.d_name, target, sizeof(target));
+ if (len <= 0 || len >= (int) sizeof(target)-1)
continue;
- }
- name = udev_device_get_devnode(ud_dev);
- /* The serial8250 driver has a hardcoded number of ports.
- * The only way to tell which actually exist on a given system
- * is to try to open them and make an ioctl call. */
- driver = udev_device_get_driver(ud_parent);
- if (driver && !strcmp(driver, "serial8250")) {
+ target[len] = 0;
+ if (strstr(target, "virtual"))
+ continue;
+ snprintf(name, sizeof(name), "/dev/%s", entry.d_name);
+ DEBUG("Found device %s", name);
+ if (strstr(target, "serial8250")) {
+ /* The serial8250 driver has a hardcoded number of ports.
+ * The only way to tell which actually exist on a given system
+ * is to try to open them and make an ioctl call. */
DEBUG("serial8250 device, attempting to open");
if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) {
DEBUG("open failed, skipping");
- goto skip;
+ continue;
}
ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
close(fd);
if (ioctl_result != 0) {
DEBUG("ioctl failed, skipping");
- goto skip;
+ continue;
}
if (serial_info.type == PORT_UNKNOWN) {
DEBUG("port type is unknown, skipping");
- goto skip;
+ continue;
}
}
DEBUG("Found port %s", name);
list = list_append(list, name);
-skip:
- udev_device_unref(ud_dev);
if (!list) {
SET_ERROR(ret, SP_ERR_MEM, "list append failed");
- goto out;
+ break;
}
}
-out:
- udev_enumerate_unref(ud_enumerate);
- udev_unref(ud);
+ closedir(dir);
#endif
switch (ret) {
*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);
DEBUG("Opening port %s", port->name);
#ifdef _WIN32
- DWORD desired_access = 0, flags_and_attributes = 0;
+ 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);
}
/* Prepare OVERLAPPED structures. */
- memset(&port->read_ovl, 0, sizeof(port->read_ovl));
- memset(&port->write_ovl, 0, sizeof(port->write_ovl));
- port->read_ovl.hEvent = INVALID_HANDLE_VALUE;
- port->write_ovl.hEvent = INVALID_HANDLE_VALUE;
- if ((port->read_ovl.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL)) == INVALID_HANDLE_VALUE) {
+#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("read event CreateEvent() failed");
+ RETURN_FAIL("SetCommMask() failed");
}
- if ((port->write_ovl.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL)) == INVALID_HANDLE_VALUE) {
- sp_close(port);
- RETURN_FAIL("write event CreateEvent() 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;
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) {
if (CloseHandle(port->hdl) == 0)
RETURN_FAIL("port CloseHandle() failed");
port->hdl = INVALID_HANDLE_VALUE;
- /* Close event handle created for overlapped reads. */
- if (port->read_ovl.hEvent != INVALID_HANDLE_VALUE && CloseHandle(port->read_ovl.hEvent) == 0)
- RETURN_FAIL("read event CloseHandle() failed");
- /* Close event handle created for overlapped writes. */
- if (port->write_ovl.hEvent != INVALID_HANDLE_VALUE && CloseHandle(port->write_ovl.hEvent) == 0)
- RETURN_FAIL("write event 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)
/* 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)
/* 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");
- port->writing = 1;
- RETURN_VALUE("%d", ++written);
+ 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.");
+ DEBUG("Single byte written immediately");
written++;
}
}
- DEBUG("All bytes written immediately.");
+ DEBUG("All bytes written immediately");
RETURN_VALUE("%d", written);
#else
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);
- RETURN_VALUE("%d", bytes_read);
} else {
RETURN_FAIL("ReadFile() failed");
}
} else {
DEBUG("Read completed immediately");
- RETURN_VALUE("%d", count);
+ 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;
RETURN_FAIL("ReadFile() failed");
/* Get number of bytes read. */
- GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
+ 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
COMSTAT comstat;
if (ClearCommError(port->hdl, &errors, &comstat) == 0)
- RETURN_FAIL("ClearComError() failed");
+ RETURN_FAIL("ClearCommError() failed");
RETURN_VALUE("%d", comstat.cbInQue);
#else
int bytes_waiting;
COMSTAT comstat;
if (ClearCommError(port->hdl, &errors, &comstat) == 0)
- RETURN_FAIL("ClearComError() failed");
+ RETURN_FAIL("ClearCommError() failed");
RETURN_VALUE("%d", comstat.cbOutQue);
#else
int bytes_waiting;
#endif
}
-#ifdef __linux__
+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");
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
}
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