X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=serialport.c;h=558322ecfff4e3d529d46998fc7e365b5135a147;hb=65172beffe8d9c4aa4b72782a9b76a4972be3c69;hp=b7dd66a3bfad1220d319a75fb141cae588ee47e7;hpb=1622ef60b032522edfecca46bd23ec1bf4b0ee64;p=libserialport.git diff --git a/serialport.c b/serialport.c index b7dd66a..558322e 100644 --- a/serialport.c +++ b/serialport.c @@ -5,6 +5,7 @@ * Copyright (C) 2010-2012 Uwe Hermann * Copyright (C) 2013 Martin Ling * Copyright (C) 2013 Matthias Heidbrink + * Copyright (C) 2014 Aurelien Jacobs * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -20,111 +21,8 @@ * along with this program. If not, see . */ -#include -#include -#include -#include -#include -#include -#include -#include -#include -#ifdef _WIN32 -#include -#include -#include -#else -#include -#include -#include -#include -#include -#endif -#ifdef __APPLE__ -#include -#include -#include -#include -#endif -#ifdef __linux__ -#ifdef HAVE_LIBUDEV -#include "libudev.h" -#endif -#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 - -/* TIOCINQ/TIOCOUTQ is not available everywhere. */ -#if !defined(TIOCINQ) && defined(FIONREAD) -#define TIOCINQ FIONREAD -#endif -#if !defined(TIOCOUTQ) && defined(FIONWRITE) -#define TIOCOUTQ FIONWRITE -#endif - -#ifndef _WIN32 -#include "linux_termios.h" -#endif - #include "libserialport.h" - -struct sp_port { - char *name; -#ifdef _WIN32 - HANDLE hdl; - COMMTIMEOUTS timeouts; - OVERLAPPED write_ovl; - OVERLAPPED read_ovl; - BYTE pending_byte; - BOOL writing; -#else - int fd; -#endif -}; - -struct sp_port_config { - int baudrate; - int bits; - enum sp_parity parity; - int stopbits; - enum sp_rts rts; - enum sp_cts cts; - enum sp_dtr dtr; - enum sp_dsr dsr; - enum sp_xonxoff xon_xoff; -}; - -struct port_data { -#ifdef _WIN32 - DCB dcb; -#else - struct termios term; - int controlbits; - int termiox_supported; - int flow; -#endif -}; - -/* Standard baud rates. */ -#ifdef _WIN32 -#define BAUD_TYPE DWORD -#define BAUD(n) {CBR_##n, n} -#else -#define BAUD_TYPE speed_t -#define BAUD(n) {B##n, n} -#endif - -struct std_baudrate { - BAUD_TYPE index; - int value; -}; +#include "libserialport_internal.h" const struct std_baudrate std_baudrates[] = { #ifdef _WIN32 @@ -148,52 +46,16 @@ const struct std_baudrate std_baudrates[] = { 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) - -/* 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 { \ - 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); 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); @@ -226,6 +88,22 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p port->fd = -1; #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; + + if ((ret = get_port_details(port)) != SP_OK) { + sp_free_port(port); + return ret; + } + *port_ptr = port; RETURN_OK(); @@ -241,6 +119,103 @@ char *sp_get_port_name(const struct sp_port *port) 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 (port->usb_bus < 0 || port->usb_address < 0) + RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available"); + + if (usb_bus) *usb_bus = port->usb_bus; + if (usb_address) *usb_address = port->usb_address; + + 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 (port->usb_vid < 0 || port->usb_pid < 0) + RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available"); + + if (usb_vid) *usb_vid = port->usb_vid; + if (usb_pid) *usb_pid = port->usb_pid; + + 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); @@ -292,6 +267,20 @@ void sp_free_port(struct sp_port *port) 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); @@ -376,7 +365,7 @@ enum sp_return sp_list_ports(struct sp_port ***list_ptr) 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 @@ -407,49 +396,35 @@ out_close: 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); @@ -463,77 +438,60 @@ out_done: IOObjectRelease(port); } out: - free(path); -out_release: IOObjectRelease(iter); out_done: #endif -#if defined(__linux__) && defined(HAVE_LIBUDEV) - 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; +#ifdef __linux__ + 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) { @@ -541,7 +499,7 @@ out: *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); @@ -608,11 +566,12 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) 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); @@ -644,17 +603,32 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) } /* 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; @@ -727,6 +701,11 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) 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) { @@ -750,12 +729,17 @@ enum sp_return sp_close(struct sp_port *port) 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) @@ -1000,20 +984,27 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_ /* 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 @@ -1059,14 +1050,22 @@ enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, u 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; @@ -1158,6 +1157,14 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count 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 ssize_t bytes_read; @@ -1188,7 +1195,7 @@ enum sp_return sp_input_waiting(struct sp_port *port) 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; @@ -1211,7 +1218,7 @@ enum sp_return sp_output_waiting(struct sp_port *port) 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; @@ -1221,7 +1228,187 @@ enum sp_return sp_output_waiting(struct sp_port *port) #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; @@ -1274,62 +1461,64 @@ static enum sp_return set_baudrate(int fd, int baudrate) 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) @@ -1444,7 +1633,7 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, 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; @@ -1466,7 +1655,7 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, 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; @@ -1507,21 +1696,21 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, 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) { @@ -1549,7 +1738,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, baud_nonstd = B0; #endif -#ifdef __linux__ +#ifdef USE_TERMIOS_SPEED int baud_nonstd = 0; #endif @@ -1575,7 +1764,6 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, 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; @@ -1717,7 +1905,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, 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"); @@ -1796,7 +1984,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, 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: @@ -1805,15 +1993,15 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, 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; @@ -1851,7 +2039,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, 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: @@ -1860,13 +2048,13 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, 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) @@ -1913,11 +2101,13 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, 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 @@ -2226,3 +2416,45 @@ void sp_default_debug_handler(const char *format, ...) } 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; +} + +/** @} */