X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=serialport.c;h=c2946a2f08c427a7a7fe5448989f88dfedefa7cb;hb=da2ede60e441566b074d512ad70b51b5751834ae;hp=522cafa5e014eebb705bce00da23653a31232d44;hpb=8cf7c6978f9fa9c7ec706440080c10755f357b5c;p=libserialport.git diff --git a/serialport.c b/serialport.c index 522cafa..c2946a2 100644 --- a/serialport.c +++ b/serialport.c @@ -27,13 +27,18 @@ #include #include #include +#include +#include #ifdef _WIN32 #include #include -#include #else +#include #include #include +#include +#include +#include #endif #ifdef __APPLE__ #include @@ -42,28 +47,83 @@ #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 + +/* 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; +#ifdef _WIN32 + HANDLE hdl; + COMMTIMEOUTS timeouts; + OVERLAPPED write_ovl; + OVERLAPPED read_ovl; + OVERLAPPED wait_ovl; + DWORD events; + 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; -#ifdef USE_TERMIOX - int flow; -#endif + int termiox_supported; + 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 @@ -98,13 +158,45 @@ const struct std_baudrate std_baudrates[] = { #endif }; +void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler; + #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0])) #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates) -#define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0) +/* Debug output macros. */ +#define DEBUG(fmt, ...) do { if (sp_debug_handler) sp_debug_handler(fmt ".\n", ##__VA_ARGS__); } while (0) +#define DEBUG_ERROR(err, 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: "fmt": %s", __func__,##__VA_ARGS__,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, ...) 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 enum sp_return validate_port(struct sp_port *port); static struct sp_port **list_append(struct sp_port **list, const char *portname); static enum sp_return get_config(struct sp_port *port, struct port_data *data, struct sp_port_config *config); @@ -116,22 +208,26 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p struct sp_port *port; int len; + TRACE("%s, %p", portname, port_ptr); + if (!port_ptr) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); *port_ptr = NULL; if (!portname) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null port name"); + + DEBUG("Building structure for port %s", portname); if (!(port = malloc(sizeof(struct sp_port)))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed"); len = strlen(portname) + 1; if (!(port->name = malloc(len))) { free(port); - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed"); } memcpy(port->name, portname, len); @@ -144,31 +240,74 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p *port_ptr = port; - return SP_OK; + RETURN_OK(); +} + +char *sp_get_port_name(const struct sp_port *port) +{ + TRACE("%p", port); + + if (!port) + return NULL; + + RETURN_VALUE("%s", port->name); +} + +enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr) +{ + TRACE("%p, %p", port, result_ptr); + + if (!port) + RETURN_ERROR(SP_ERR_ARG, "Null port"); + +#ifdef _WIN32 + HANDLE *handle_ptr = result_ptr; + *handle_ptr = port->hdl; +#else + int *fd_ptr = result_ptr; + *fd_ptr = port->fd; +#endif + + RETURN_OK(); } enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr) { + TRACE("%p, %p", port, copy_ptr); + if (!copy_ptr) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); *copy_ptr = NULL; - if (!port || !port->name) - return SP_ERR_ARG; + if (!port) + RETURN_ERROR(SP_ERR_ARG, "Null port"); + + if (!port->name) + RETURN_ERROR(SP_ERR_ARG, "Null port name"); + + DEBUG("Copying port structure"); - return sp_get_port_by_name(port->name, copy_ptr); + RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr)); } void sp_free_port(struct sp_port *port) { - if (!port) - return; + TRACE("%p", port); + + if (!port) { + DEBUG("Null port"); + RETURN(); + } + + DEBUG("Freeing port structure"); if (port->name) free(port->name); free(port); + + RETURN(); } static struct sp_port **list_append(struct sp_port **list, const char *portname) @@ -193,10 +332,17 @@ fail: enum sp_return sp_list_ports(struct sp_port ***list_ptr) { struct sp_port **list; - int ret = SP_OK; + int ret = SP_ERR_SUPP; + + TRACE("%p", list_ptr); + + if (!list_ptr) + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); + + DEBUG("Enumerating ports"); if (!(list = malloc(sizeof(struct sp_port **)))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed"); list[0] = NULL; @@ -209,25 +355,30 @@ enum sp_return sp_list_ports(struct sp_port ***list_ptr) char *name; int name_len; + ret = SP_OK; + + DEBUG("Opening registry key"); if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"), 0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "RegOpenKeyEx() failed"); goto out_done; } + DEBUG("Querying registry key value and data sizes"); if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "RegQueryInfoKey() failed"); goto out_close; } max_data_len = max_data_size / sizeof(TCHAR); if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "registry value malloc failed"); goto out_close; } if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "registry data malloc failed"); goto out_free_value; } + DEBUG("Iterating over values"); while ( value_len = max_value_len + 1, data_size = max_data_size, @@ -237,12 +388,12 @@ 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 if (!(name = malloc(name_len))) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "registry port name malloc failed"); goto out; } #ifdef UNICODE @@ -250,9 +401,12 @@ enum sp_return sp_list_ports(struct sp_port ***list_ptr) #else strcpy(name, data); #endif - if (type == REG_SZ && !(list = list_append(list, name))) { - ret = SP_ERR_MEM; - goto out; + if (type == REG_SZ) { + DEBUG("Found port %s", name); + if (!(list = list_append(list, name))) { + SET_ERROR(ret, SP_ERR_MEM, "list append failed"); + goto out; + } } index++; } @@ -273,29 +427,35 @@ out_done: CFTypeRef cf_path; Boolean result; + ret = SP_OK; + + DEBUG("Getting IOKit master port"); if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "IOMasterPort() failed"); goto out_done; } + DEBUG("Creating matching dictionary"); if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "IOServiceMatching() failed"); goto out_done; } CFDictionarySetValue(classes, CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes)); + DEBUG("Getting matching services"); if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS) { - ret = SP_ERR_FAIL; + SET_FAIL(ret, "IOServiceGetMatchingServices() failed"); goto out_done; } if (!(path = malloc(PATH_MAX))) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "device path malloc failed"); goto out_release; } + DEBUG("Iterating over results"); while ((port = IOIteratorNext(iter))) { cf_path = IORegistryEntryCreateCFProperty(port, CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0); @@ -303,10 +463,13 @@ out_done: result = CFStringGetCString(cf_path, path, PATH_MAX, kCFStringEncodingASCII); CFRelease(cf_path); - if (result && !(list = list_append(list, path))) { - ret = SP_ERR_MEM; - IOObjectRelease(port); - goto out; + if (result) { + DEBUG("Found port %s", path); + if (!(list = list_append(list, path))) { + SET_ERROR(ret, SP_ERR_MEM, "list append failed"); + IOObjectRelease(port); + goto out; + } } } IOObjectRelease(port); @@ -317,7 +480,7 @@ out_release: IOObjectRelease(iter); out_done: #endif -#ifdef __linux__ +#if defined(__linux__) && defined(HAVE_LIBUDEV) struct udev *ud; struct udev_enumerate *ud_enumerate; struct udev_list_entry *ud_list; @@ -329,17 +492,23 @@ out_done: 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; } @@ -349,20 +518,28 @@ out_done: * is to try to open them and make an ioctl call. */ driver = udev_device_get_driver(ud_parent); if (driver && !strcmp(driver, "serial8250")) { - if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) + DEBUG("serial8250 device, attempting to open"); + if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) { + DEBUG("open failed, skipping"); goto skip; + } ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info); close(fd); - if (ioctl_result != 0) + if (ioctl_result != 0) { + DEBUG("ioctl failed, skipping"); goto skip; - if (serial_info.type == PORT_UNKNOWN) + } + if (serial_info.type == PORT_UNKNOWN) { + DEBUG("port type is unknown, skipping"); goto skip; + } } + DEBUG("Found port %s", name); list = list_append(list, name); skip: udev_device_unref(ud_dev); if (!list) { - ret = SP_ERR_MEM; + SET_ERROR(ret, SP_ERR_MEM, "list append failed"); goto out; } } @@ -371,64 +548,93 @@ out: udev_unref(ud); #endif - if (ret == SP_OK) { + switch (ret) { + case SP_OK: *list_ptr = list; - } else { + RETURN_OK(); + case SP_ERR_SUPP: + DEBUG_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform"); + default: if (list) sp_free_port_list(list); *list_ptr = NULL; + return ret; } - - return ret; } void sp_free_port_list(struct sp_port **list) { unsigned int i; + TRACE("%p", list); + + if (!list) { + DEBUG("Null list"); + RETURN(); + } + + DEBUG("Freeing port list"); + for (i = 0; list[i]; i++) sp_free_port(list[i]); free(list); + + RETURN(); } -static enum sp_return validate_port(struct sp_port *port) -{ - if (port == NULL) - return 0; +#define CHECK_PORT() do { \ + if (port == NULL) \ + RETURN_ERROR(SP_ERR_ARG, "Null port"); \ + if (port->name == NULL) \ + RETURN_ERROR(SP_ERR_ARG, "Null port name"); \ +} while (0) #ifdef _WIN32 - if (port->hdl == INVALID_HANDLE_VALUE) - return 0; +#define CHECK_PORT_HANDLE() do { \ + if (port->hdl == INVALID_HANDLE_VALUE) \ + RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \ +} while (0) #else - if (port->fd < 0) - return 0; +#define CHECK_PORT_HANDLE() do { \ + if (port->fd < 0) \ + RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \ +} while (0) #endif - return 1; -} - -#define CHECK_PORT() do { if (!validate_port(port)) return SP_ERR_ARG; } while (0) +#define CHECK_OPEN_PORT() do { \ + CHECK_PORT(); \ + CHECK_PORT_HANDLE(); \ +} while (0) enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) { - if (!port) - return SP_ERR_ARG; + struct port_data data; + struct sp_port_config config; + enum sp_return ret; + + TRACE("%p, 0x%x", port, flags); + + CHECK_PORT(); + + if (flags > (SP_MODE_READ | SP_MODE_WRITE)) + RETURN_ERROR(SP_ERR_ARG, "Invalid 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)))) - return SP_ERR_MEM; + 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); /* Map 'flags' to the OS-specific settings. */ - flags_and_attributes = FILE_ATTRIBUTE_NORMAL; + flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED; if (flags & SP_MODE_READ) desired_access |= GENERIC_READ; if (flags & SP_MODE_WRITE) desired_access |= GENERIC_WRITE; - if (flags & SP_MODE_NONBLOCK) - flags_and_attributes |= FILE_FLAG_OVERLAPPED; port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0, OPEN_EXISTING, flags_and_attributes, 0); @@ -436,12 +642,53 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) free(escaped_port_name); if (port->hdl == INVALID_HANDLE_VALUE) - return SP_ERR_FAIL; + RETURN_FAIL("port CreateFile() failed"); + + /* All timeouts initially disabled. */ + port->timeouts.ReadIntervalTimeout = 0; + port->timeouts.ReadTotalTimeoutMultiplier = 0; + port->timeouts.ReadTotalTimeoutConstant = 0; + port->timeouts.WriteTotalTimeoutMultiplier = 0; + port->timeouts.WriteTotalTimeoutConstant = 0; + + if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) { + sp_close(port); + RETURN_FAIL("SetCommTimeouts() failed"); + } + + /* Prepare OVERLAPPED structures. */ +#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("SetCommMask() failed"); + } + + /* Start background operation for RX and error events. */ + if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) { + if (GetLastError() != ERROR_IO_PENDING) { + sp_close(port); + RETURN_FAIL("WaitCommEvent() failed"); + } + } + + port->writing = FALSE; + #else - int flags_local = 0; - struct port_data data; - struct sp_port_config config; - int ret; + int flags_local = O_NONBLOCK | O_NOCTTY; /* Map 'flags' to the OS-specific settings. */ if (flags & (SP_MODE_READ | SP_MODE_WRITE)) @@ -450,64 +697,125 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags) flags_local |= O_RDONLY; else if (flags & SP_MODE_WRITE) flags_local |= O_WRONLY; - if (flags & SP_MODE_NONBLOCK) - flags_local |= O_NONBLOCK; if ((port->fd = open(port->name, flags_local)) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("open() failed"); +#endif ret = get_config(port, &data, &config); if (ret < 0) { sp_close(port); - return ret; + RETURN_CODEVAL(ret); } - /* Turn off all serial port cooking. */ - data.term.c_iflag &= ~(ISTRIP | INLCR | ICRNL); - data.term.c_oflag &= ~(ONLCR | OCRNL | ONOCR); -#if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__) + /* Set sane port settings. */ +#ifdef _WIN32 + data.dcb.fBinary = TRUE; + data.dcb.fDsrSensitivity = FALSE; + data.dcb.fErrorChar = FALSE; + data.dcb.fNull = FALSE; + data.dcb.fAbortOnError = TRUE; +#else + /* Turn off all fancy termios tricks, give us a raw channel. */ + data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL); +#ifdef IUCLC + data.term.c_iflag &= ~IUCLC; +#endif + data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET); +#ifdef OLCUC + data.term.c_oflag &= ~OLCUC; +#endif +#ifdef NLDLY + data.term.c_oflag &= ~NLDLY; +#endif +#ifdef CRDLY + data.term.c_oflag &= ~CRDLY; +#endif +#ifdef TABDLY + data.term.c_oflag &= ~TABDLY; +#endif +#ifdef BSDLY + data.term.c_oflag &= ~BSDLY; +#endif +#ifdef VTDLY + data.term.c_oflag &= ~VTDLY; +#endif +#ifdef FFDLY + data.term.c_oflag &= ~FFDLY; +#endif +#ifdef OFILL data.term.c_oflag &= ~OFILL; #endif - /* Disable canonical mode, and don't echo input characters. */ - data.term.c_lflag &= ~(ICANON | ECHO); + data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN); + data.term.c_cc[VMIN] = 0; + data.term.c_cc[VTIME] = 0; + + /* Ignore modem status lines; enable receiver; leave control lines alone on close. */ + data.term.c_cflag |= (CLOCAL | CREAD | HUPCL); +#endif - /* Ignore modem status lines; enable receiver */ - data.term.c_cflag |= (CLOCAL | CREAD); +#ifdef _WIN32 + if (ClearCommError(port->hdl, &errors, &status) == 0) + RETURN_FAIL("ClearCommError() failed"); +#endif ret = set_config(port, &data, &config); if (ret < 0) { sp_close(port); - return ret; + RETURN_CODEVAL(ret); } -#endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_close(struct sp_port *port) { - CHECK_PORT(); + TRACE("%p", port); + + CHECK_OPEN_PORT(); + + DEBUG("Closing port %s", port->name); #ifdef _WIN32 /* Returns non-zero upon success, 0 upon failure. */ if (CloseHandle(port->hdl) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("port CloseHandle() failed"); port->hdl = INVALID_HANDLE_VALUE; + + /* 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) - return SP_ERR_FAIL; + RETURN_FAIL("close() failed"); port->fd = -1; #endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) { - CHECK_PORT(); + TRACE("%p, 0x%x", port, buffers); + + CHECK_OPEN_PORT(); + + if (buffers > SP_BUF_BOTH) + RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection"); + + const char *buffer_names[] = {"no", "input", "output", "both"}; + + DEBUG("Flushing %s buffers on port %s", buffer_names[buffers], port->name); #ifdef _WIN32 DWORD flags = 0; @@ -516,169 +824,768 @@ enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers) if (buffers & SP_BUF_OUTPUT) flags |= PURGE_TXCLEAR; - /* Returns non-zero upon success, 0 upon failure. */ - if (PurgeComm(port->hdl, flags) == 0) - return SP_ERR_FAIL; -#else - int flags = 0; - if (buffers & SP_BUF_BOTH) - flags = TCIOFLUSH; - else if (buffers & SP_BUF_INPUT) - flags = TCIFLUSH; - if (buffers & SP_BUF_OUTPUT) - flags = TCOFLUSH; + /* Returns non-zero upon success, 0 upon failure. */ + if (PurgeComm(port->hdl, flags) == 0) + RETURN_FAIL("PurgeComm() failed"); +#else + int flags = 0; + if (buffers & SP_BUF_BOTH) + flags = TCIOFLUSH; + else if (buffers & SP_BUF_INPUT) + flags = TCIFLUSH; + else if (buffers & SP_BUF_OUTPUT) + flags = TCOFLUSH; + + /* Returns 0 upon success, -1 upon failure. */ + if (tcflush(port->fd, flags) < 0) + RETURN_FAIL("tcflush() failed"); +#endif + RETURN_OK(); +} + +enum sp_return sp_drain(struct sp_port *port) +{ + TRACE("%p", port); + + CHECK_OPEN_PORT(); + + DEBUG("Draining port %s", port->name); + +#ifdef _WIN32 + /* Returns non-zero upon success, 0 upon failure. */ + if (FlushFileBuffers(port->hdl) == 0) + RETURN_FAIL("FlushFileBuffers() failed"); + RETURN_OK(); +#else + 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 +} + +enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout) +{ + TRACE("%p, %p, %d, %d", port, buf, count, timeout); + + CHECK_OPEN_PORT(); + + if (!buf) + RETURN_ERROR(SP_ERR_ARG, "Null buffer"); + + if (timeout) + DEBUG("Writing %d bytes to port %s, timeout %d ms", count, port->name, timeout); + else + DEBUG("Writing %d bytes to port %s, no timeout", count, port->name); + + if (count == 0) + RETURN_VALUE("0", 0); + +#ifdef _WIN32 + DWORD bytes_written = 0; + BOOL result; + + /* Wait for previous non-blocking write to complete, if any. */ + if (port->writing) { + DEBUG("Waiting for previous write to complete"); + result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE); + port->writing = 0; + if (!result) + RETURN_FAIL("Previous write failed to complete"); + DEBUG("Previous write completed"); + } + + /* Set timeout. */ + port->timeouts.WriteTotalTimeoutConstant = timeout; + if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) + RETURN_FAIL("SetCommTimeouts() failed"); + + /* Start write. */ + if (WriteFile(port->hdl, buf, count, NULL, &port->write_ovl) == 0) { + if (GetLastError() == ERROR_IO_PENDING) { + DEBUG("Waiting for write to complete"); + GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE); + DEBUG("Write completed, %d/%d bytes written", bytes_written, count); + RETURN_VALUE("%d", bytes_written); + } else { + RETURN_FAIL("WriteFile() failed"); + } + } else { + DEBUG("Write completed immediately"); + RETURN_VALUE("%d", count); + } +#else + size_t bytes_written = 0; + unsigned char *ptr = (unsigned char *) buf; + struct timeval start, delta, now, end = {0, 0}; + fd_set fds; + int result; + + 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 we have written the requested number of bytes. */ + while (bytes_written < count) + { + /* Wait until space is available. */ + FD_ZERO(&fds); + FD_SET(port->fd, &fds); + if (timeout) { + gettimeofday(&now, NULL); + if (timercmp(&now, &end, >)) { + DEBUG("write timed out"); + RETURN_VALUE("%d", bytes_written); + } + timersub(&end, &now, &delta); + } + result = select(port->fd + 1, NULL, &fds, NULL, timeout ? &delta : NULL); + if (result < 0) { + if (errno == EINTR) { + DEBUG("select() call was interrupted, repeating"); + continue; + } else { + RETURN_FAIL("select() failed"); + } + } else if (result == 0) { + DEBUG("write timed out"); + RETURN_VALUE("%d", bytes_written); + } + + /* Do write. */ + result = write(port->fd, ptr, count - bytes_written); + + if (result < 0) { + if (errno == EAGAIN) + /* This shouldn't happen because we did a select() first, but handle anyway. */ + continue; + else + /* This is an actual failure. */ + RETURN_FAIL("write() failed"); + } + + bytes_written += result; + ptr += result; + } + + RETURN_VALUE("%d", bytes_written); +#endif +} + +enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_t count) +{ + TRACE("%p, %p, %d", port, buf, count); + + CHECK_OPEN_PORT(); + + if (!buf) + RETURN_ERROR(SP_ERR_ARG, "Null buffer"); + + DEBUG("Writing up to %d bytes to port %s", count, port->name); + + if (count == 0) + RETURN_VALUE("0", 0); + +#ifdef _WIN32 + DWORD written = 0; + BYTE *ptr = (BYTE *) buf; + + /* Check whether previous write is complete. */ + if (port->writing) { + if (HasOverlappedIoCompleted(&port->write_ovl)) { + DEBUG("Previous write completed"); + port->writing = 0; + } else { + DEBUG("Previous write not complete"); + /* Can't take a new write until the previous one finishes. */ + RETURN_VALUE("0", 0); + } + } + + /* Set timeout. */ + port->timeouts.WriteTotalTimeoutConstant = 0; + if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) + RETURN_FAIL("SetCommTimeouts() failed"); + + /* Keep writing data until the OS has to actually start an async IO for it. + * At that point we know the buffer is full. */ + while (written < count) + { + /* Copy first byte of user buffer. */ + port->pending_byte = *ptr++; + + /* Start asynchronous write. */ + if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) { + if (GetLastError() == ERROR_IO_PENDING) { + 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"); + written++; + } + } + + DEBUG("All bytes written immediately"); + + RETURN_VALUE("%d", written); +#else + /* Returns the number of bytes written, or -1 upon failure. */ + ssize_t written = write(port->fd, buf, count); + + if (written < 0) + RETURN_FAIL("write() failed"); + else + RETURN_VALUE("%d", written); +#endif +} + +enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout) +{ + TRACE("%p, %p, %d, %d", port, buf, count, timeout); + + CHECK_OPEN_PORT(); + + if (!buf) + RETURN_ERROR(SP_ERR_ARG, "Null buffer"); + + if (timeout) + DEBUG("Reading %d bytes from port %s, timeout %d ms", count, port->name, timeout); + else + DEBUG("Reading %d bytes from port %s, no timeout", count, port->name); + + if (count == 0) + RETURN_VALUE("0", 0); + +#ifdef _WIN32 + DWORD bytes_read = 0; + + /* Set timeout. */ + port->timeouts.ReadIntervalTimeout = 0; + port->timeouts.ReadTotalTimeoutConstant = timeout; + if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) + RETURN_FAIL("SetCommTimeouts() failed"); + + /* Start read. */ + if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0) { + if (GetLastError() == ERROR_IO_PENDING) { + DEBUG("Waiting for read to complete"); + GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE); + DEBUG("Read completed, %d/%d bytes read", bytes_read, count); + } else { + RETURN_FAIL("ReadFile() failed"); + } + } else { + DEBUG("Read completed immediately"); + 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; + struct timeval start, delta, now, end = {0, 0}; + fd_set fds; + int result; + + 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 we have the requested number of bytes. */ + while (bytes_read < count) + { + /* Wait until data is available. */ + FD_ZERO(&fds); + FD_SET(port->fd, &fds); + if (timeout) { + gettimeofday(&now, NULL); + if (timercmp(&now, &end, >)) + /* Timeout has expired. */ + RETURN_VALUE("%d", bytes_read); + timersub(&end, &now, &delta); + } + result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL); + if (result < 0) { + if (errno == EINTR) { + DEBUG("select() call was interrupted, repeating"); + continue; + } else { + RETURN_FAIL("select() failed"); + } + } else if (result == 0) { + DEBUG("read timed out"); + RETURN_VALUE("%d", bytes_read); + } + + /* Do read. */ + result = read(port->fd, ptr, count - bytes_read); + + if (result < 0) { + if (errno == EAGAIN) + /* This shouldn't happen because we did a select() first, but handle anyway. */ + continue; + else + /* This is an actual failure. */ + RETURN_FAIL("read() failed"); + } + + bytes_read += result; + ptr += result; + } + + RETURN_VALUE("%d", bytes_read); +#endif +} + +enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count) +{ + TRACE("%p, %p, %d", port, buf, count); + + 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; + + /* Set timeout. */ + port->timeouts.ReadIntervalTimeout = MAXDWORD; + port->timeouts.ReadTotalTimeoutConstant = 0; + if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) + RETURN_FAIL("SetCommTimeouts() failed"); + + /* Do read. */ + if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0) + RETURN_FAIL("ReadFile() failed"); + + /* Get number of bytes read. */ + 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; + + /* Returns the number of bytes read, or -1 upon failure. */ + if ((bytes_read = read(port->fd, buf, count)) < 0) { + if (errno == EAGAIN) + /* No bytes available. */ + bytes_read = 0; + else + /* This is an actual failure. */ + RETURN_FAIL("read() failed"); + } + RETURN_VALUE("%d", bytes_read); +#endif +} + +enum sp_return sp_input_waiting(struct sp_port *port) +{ + TRACE("%p", port); + + CHECK_OPEN_PORT(); + + DEBUG("Checking input bytes waiting on port %s", port->name); + +#ifdef _WIN32 + DWORD errors; + COMSTAT comstat; + + if (ClearCommError(port->hdl, &errors, &comstat) == 0) + RETURN_FAIL("ClearCommError() failed"); + RETURN_VALUE("%d", comstat.cbInQue); +#else + int bytes_waiting; + if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0) + RETURN_FAIL("TIOCINQ ioctl failed"); + RETURN_VALUE("%d", bytes_waiting); +#endif +} + +enum sp_return sp_output_waiting(struct sp_port *port) +{ + TRACE("%p", port); + + CHECK_OPEN_PORT(); + + DEBUG("Checking output bytes waiting on port %s", port->name); + +#ifdef _WIN32 + DWORD errors; + COMSTAT comstat; + + if (ClearCommError(port->hdl, &errors, &comstat) == 0) + RETURN_FAIL("ClearCommError() failed"); + RETURN_VALUE("%d", comstat.cbOutQue); +#else + int bytes_waiting; + if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0) + RETURN_FAIL("TIOCOUTQ ioctl failed"); + RETURN_VALUE("%d", bytes_waiting); +#endif +} + +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++; - /* Returns 0 upon success, -1 upon failure. */ - if (tcflush(port->fd, flags) < 0) - return SP_ERR_FAIL; -#endif - return SP_OK; + RETURN_OK(); } -enum sp_return sp_drain(struct sp_port *port) +enum sp_return sp_add_port_events(struct sp_event_set *event_set, + const struct sp_port *port, enum sp_event mask) { - CHECK_PORT(); + 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 - /* Returns non-zero upon success, 0 upon failure. */ - if (FlushFileBuffers(port->hdl) == 0) - return SP_ERR_FAIL; + 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 - /* Returns 0 upon success, -1 upon failure. */ - if (tcdrain(port->fd) < 0) - return SP_ERR_FAIL; + TRY(add_handle(event_set, port->fd, mask)); #endif - return SP_OK; + RETURN_OK(); } -enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count) +void sp_free_event_set(struct sp_event_set *event_set) { - CHECK_PORT(); + TRACE("%p", event_set); - if (!buf) - return SP_ERR_ARG; + if (!event_set) { + DEBUG("Null event set"); + RETURN(); + } -#ifdef _WIN32 - DWORD written = 0; + DEBUG("Freeing event set"); - /* Returns non-zero upon success, 0 upon failure. */ - if (WriteFile(port->hdl, buf, count, &written, NULL) == 0) - return SP_ERR_FAIL; - return written; -#else - /* Returns the number of bytes written, or -1 upon failure. */ - ssize_t written = write(port->fd, buf, count); + if (event_set->handles) + free(event_set->handles); + if (event_set->masks) + free(event_set->masks); - if (written < 0) - return SP_ERR_FAIL; - else - return written; -#endif + free(event_set); + + RETURN(); } -enum sp_return sp_read(struct sp_port *port, void *buf, size_t count) +enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout) { - CHECK_PORT(); + TRACE("%p, %d", event_set, timeout); - if (!buf) - return SP_ERR_ARG; + if (!event_set) + RETURN_ERROR(SP_ERR_ARG, "Null event set"); #ifdef _WIN32 - DWORD bytes_read = 0; + if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE, + timeout ? timeout : INFINITE) == WAIT_FAILED) + RETURN_FAIL("WaitForMultipleObjects() failed"); - /* Returns non-zero upon success, 0 upon failure. */ - if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0) - return SP_ERR_FAIL; - return bytes_read; + RETURN_OK(); #else - ssize_t bytes_read; + struct timeval start, delta, now, end = {0, 0}; + int result, timeout_remaining; + struct pollfd *pollfds; + unsigned int i; - /* Returns the number of bytes read, or -1 upon failure. */ - if ((bytes_read = read(port->fd, buf, count)) < 0) - return SP_ERR_FAIL; - return bytes_read; + 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 __linux__ +#ifdef USE_TERMIOS_SPEED static enum sp_return get_baudrate(int fd, int *baudrate) { void *data; + TRACE("%d, %p", fd, baudrate); + + DEBUG("Getting baud rate"); + if (!(data = malloc(get_termios_size()))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "termios malloc failed"); - if (ioctl(fd, get_termios_get_ioctl(), data) < 0) - return SP_ERR_FAIL; + if (ioctl(fd, get_termios_get_ioctl(), data) < 0) { + free(data); + RETURN_FAIL("getting termios failed"); + } *baudrate = get_termios_speed(data); - return SP_OK; + free(data); + + RETURN_OK(); } static enum sp_return set_baudrate(int fd, int baudrate) { void *data; + TRACE("%d, %d", fd, baudrate); + + DEBUG("Getting baud rate"); + if (!(data = malloc(get_termios_size()))) - return SP_ERR_MEM; + RETURN_ERROR(SP_ERR_MEM, "termios malloc failed"); + + if (ioctl(fd, get_termios_get_ioctl(), data) < 0) { + free(data); + RETURN_FAIL("getting termios failed"); + } - if (ioctl(fd, get_termios_get_ioctl(), data) < 0) - return SP_ERR_FAIL; + DEBUG("Setting baud rate"); set_termios_speed(data, baudrate); - if (ioctl(fd, get_termios_set_ioctl(), data) < 0) - return SP_ERR_FAIL; + if (ioctl(fd, get_termios_set_ioctl(), data) < 0) { + free(data); + RETURN_FAIL("setting termios failed"); + } + + free(data); - return SP_OK; + RETURN_OK(); } +#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, data); - if (!(data = malloc(get_termiox_size()))) - return SP_ERR_MEM; + DEBUG("Getting advanced flow control"); - if (ioctl(fd, TCGETX, data) < 0) - return SP_ERR_FAIL; + if (!(termx = malloc(get_termiox_size()))) + RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed"); - *flow = get_termiox_flow(data); + if (ioctl(fd, TCGETX, termx) < 0) { + free(termx); + RETURN_FAIL("getting termiox failed"); + } + + get_termiox_flow(termx, &data->rts_flow, &data->cts_flow, + &data->dtr_flow, &data->dsr_flow); - return SP_OK; + 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; - if (!(data = malloc(get_termiox_size()))) - return SP_ERR_MEM; + TRACE("%d, %p", fd, data); - if (ioctl(fd, TCGETX, data) < 0) - return SP_ERR_FAIL; + DEBUG("Getting advanced flow control"); - set_termiox_flow(data, flow); + if (!(termx = malloc(get_termiox_size()))) + RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed"); - if (ioctl(fd, TCSETX, data) < 0) - return SP_ERR_FAIL; + if (ioctl(fd, TCGETX, termx) < 0) { + free(termx); + RETURN_FAIL("getting termiox failed"); + } + + DEBUG("Setting advanced flow control"); + + set_termiox_flow(termx, data->rts_flow, data->cts_flow, + data->dtr_flow, data->dsr_flow); + + if (ioctl(fd, TCSETX, termx) < 0) { + free(termx); + RETURN_FAIL("setting termiox failed"); + } + + free(termx); - return SP_OK; + 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) { unsigned int i; + TRACE("%p, %p, %p", port, data, config); + + DEBUG("Getting configuration for port %s", port->name); + #ifdef _WIN32 if (!GetCommState(port->hdl, &data->dcb)) - return SP_ERR_FAIL; + RETURN_FAIL("GetCommState() failed"); for (i = 0; i < NUM_STD_BAUDRATES; i++) { if (data->dcb.BaudRate == std_baudrates[i].index) { @@ -698,11 +1605,17 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, case NOPARITY: config->parity = SP_PARITY_NONE; break; + case ODDPARITY: + config->parity = SP_PARITY_ODD; + break; case EVENPARITY: config->parity = SP_PARITY_EVEN; break; - case ODDPARITY: - config->parity = SP_PARITY_ODD; + case MARKPARITY: + config->parity = SP_PARITY_MARK; + break; + case SPACEPARITY: + config->parity = SP_PARITY_SPACE; break; default: config->parity = -1; @@ -768,13 +1681,22 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, #else // !_WIN32 if (tcgetattr(port->fd, &data->term) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("tcgetattr() failed"); if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("TIOCMGET ioctl failed"); #ifdef USE_TERMIOX - TRY(get_flow(port->fd, &data->flow)); + int ret = get_flow(port->fd, data); + + if (ret == SP_ERR_FAIL && errno == EINVAL) + data->termiox_supported = 0; + else if (ret < 0) + RETURN_CODEVAL(ret); + else + data->termiox_supported = 1; +#else + data->termiox_supported = 0; #endif for (i = 0; i < NUM_STD_BAUDRATES; i++) { @@ -787,7 +1709,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; @@ -815,6 +1737,10 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, config->parity = SP_PARITY_NONE; else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR)) config->parity = -1; +#ifdef CMSPAR + else if (data->term.c_cflag & CMSPAR) + config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE; +#endif else config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN; @@ -824,30 +1750,22 @@ 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 { -#ifdef USE_TERMIOX - if (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->flow & CTS_FLOW) ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE; -#else - config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF; - config->cts = SP_CTS_IGNORE; -#endif + config->cts = (data->termiox_supported && data->cts_flow) ? + SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE; } -#ifdef USE_TERMIOX - if (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->flow & DSR_FLOW) ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE; -#else - config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF; - config->dsr = SP_DSR_IGNORE; -#endif + config->dsr = (data->termiox_supported && data->dsr_flow) ? + SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE; if (data->term.c_iflag & IXOFF) { if (data->term.c_iflag & IXON) @@ -862,7 +1780,7 @@ static enum sp_return get_config(struct sp_port *port, struct port_data *data, } #endif - return SP_OK; + RETURN_OK(); } static enum sp_return set_config(struct sp_port *port, struct port_data *data, @@ -874,10 +1792,14 @@ 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 + 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++) { @@ -896,18 +1818,23 @@ 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; + case SP_PARITY_ODD: + data->dcb.Parity = ODDPARITY; + break; case SP_PARITY_EVEN: data->dcb.Parity = EVENPARITY; break; - case SP_PARITY_ODD: - data->dcb.Parity = ODDPARITY; + case SP_PARITY_MARK: + data->dcb.Parity = MARKPARITY; + break; + case SP_PARITY_SPACE: + data->dcb.Parity = SPACEPARITY; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting"); } } @@ -921,7 +1848,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.StopBits = TWOSTOPBITS; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting"); } } @@ -937,7 +1864,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting"); } } @@ -950,7 +1877,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fOutxCtsFlow = TRUE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting"); } } @@ -966,7 +1893,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting"); } } @@ -979,7 +1906,7 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fOutxDsrFlow = TRUE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting"); } } @@ -1002,12 +1929,12 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->dcb.fOutX = TRUE; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting"); } } if (!SetCommState(port->hdl, &data->dcb)) - return SP_ERR_FAIL; + RETURN_FAIL("SetCommState() failed"); #else /* !_WIN32 */ @@ -1017,10 +1944,10 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, for (i = 0; i < NUM_STD_BAUDRATES; i++) { if (config->baudrate == std_baudrates[i].value) { if (cfsetospeed(&data->term, std_baudrates[i].index) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("cfsetospeed() failed"); if (cfsetispeed(&data->term, std_baudrates[i].index) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("cfsetispeed() failed"); break; } } @@ -1028,14 +1955,14 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, /* Non-standard baud rate */ if (i == NUM_STD_BAUDRATES) { #ifdef __APPLE__ - /* Set "dummy" baud rate */ + /* Set "dummy" baud rate. */ if (cfsetspeed(&data->term, B9600) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("cfsetspeed() failed"); baud_nonstd = config->baudrate; -#elif defined(__linux__) +#elif defined(USE_TERMIOS_SPEED) baud_nonstd = 1; #else - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported"); #endif } } @@ -1056,13 +1983,16 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->term.c_cflag |= CS5; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting"); } } if (config->parity >= 0) { data->term.c_iflag &= ~IGNPAR; data->term.c_cflag &= ~(PARENB | PARODD); +#ifdef CMSPAR + data->term.c_cflag &= ~CMSPAR; +#endif switch (config->parity) { case SP_PARITY_NONE: data->term.c_iflag |= IGNPAR; @@ -1073,8 +2003,22 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, case SP_PARITY_ODD: data->term.c_cflag |= PARENB | PARODD; break; +#ifdef CMSPAR + case SP_PARITY_MARK: + data->term.c_cflag |= PARENB | PARODD; + data->term.c_cflag |= CMSPAR; + break; + case SP_PARITY_SPACE: + data->term.c_cflag |= PARENB; + data->term.c_cflag |= CMSPAR; + break; +#else + case SP_PARITY_MARK: + case SP_PARITY_SPACE: + RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported"); +#endif default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting"); } } @@ -1088,97 +2032,95 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->term.c_cflag |= CSTOPB; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting"); } } if (config->rts >= 0 || config->cts >= 0) { -#ifdef USE_TERMIOX - data->flow &= ~(RTS_FLOW | CTS_FLOW); - switch (config->rts) { + if (data->termiox_supported) { + data->rts_flow = data->cts_flow = 0; + switch (config->rts) { case SP_RTS_OFF: case SP_RTS_ON: controlbits = TIOCM_RTS; - if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, - &controlbits) < 0) - return SP_ERR_FAIL; + if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0) + RETURN_FAIL("Setting RTS signal level failed"); break; case SP_RTS_FLOW_CONTROL: - data->flow |= RTS_FLOW; + data->rts_flow = 1; break; default: break; - } - if (config->cts == SP_CTS_FLOW_CONTROL) - data->flow |= CTS_FLOW; - - if (data->flow & (RTS_FLOW | CTS_FLOW)) - data->term.c_iflag |= CRTSCTS; - else - data->term.c_iflag &= ~CRTSCTS; -#else - /* Asymmetric use of RTS/CTS not supported. */ - if (data->term.c_iflag & CRTSCTS) { - /* Flow control can only be disabled for both RTS & CTS together. */ - if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) { - if (config->cts != SP_CTS_IGNORE) - return SP_ERR_ARG; } - if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) { - if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL) - return SP_ERR_ARG; - } - } else { - /* Flow control can only be enabled for both RTS & CTS together. */ - if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) || - ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL))) - return SP_ERR_ARG; - } + if (config->cts == SP_CTS_FLOW_CONTROL) + data->cts_flow = 1; - if (config->rts >= 0) { - if (config->rts == SP_RTS_FLOW_CONTROL) { + if (data->rts_flow && data->cts_flow) data->term.c_iflag |= CRTSCTS; + else + data->term.c_iflag &= ~CRTSCTS; + } else { + /* Asymmetric use of RTS/CTS not supported. */ + if (data->term.c_iflag & CRTSCTS) { + /* Flow control can only be disabled for both RTS & CTS together. */ + if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) { + if (config->cts != SP_CTS_IGNORE) + RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together"); + } + if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) { + if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL) + RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together"); + } } else { - controlbits = TIOCM_RTS; - if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, - &controlbits) < 0) - return SP_ERR_FAIL; + /* Flow control can only be enabled for both RTS & CTS together. */ + if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) || + ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL))) + RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together"); + } + + if (config->rts >= 0) { + if (config->rts == SP_RTS_FLOW_CONTROL) { + data->term.c_iflag |= CRTSCTS; + } else { + controlbits = TIOCM_RTS; + if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, + &controlbits) < 0) + RETURN_FAIL("Setting RTS signal level failed"); + } } } -#endif } if (config->dtr >= 0 || config->dsr >= 0) { -#ifdef USE_TERMIOX - data->flow &= ~(DTR_FLOW | DSR_FLOW); - switch (config->dtr) { + if (data->termiox_supported) { + data->dtr_flow = data->dsr_flow = 0; + switch (config->dtr) { case SP_DTR_OFF: case SP_DTR_ON: controlbits = TIOCM_DTR; - if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, - &controlbits) < 0) - return SP_ERR_FAIL; + if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0) + RETURN_FAIL("Setting DTR signal level failed"); break; case SP_DTR_FLOW_CONTROL: - data->flow |= DTR_FLOW; + data->dtr_flow = 1; break; default: break; + } + if (config->dsr == SP_DSR_FLOW_CONTROL) + 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_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported"); + + if (config->dtr >= 0) { + controlbits = TIOCM_DTR; + if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, + &controlbits) < 0) + RETURN_FAIL("Setting DTR signal level failed"); + } } - if (config->dsr == SP_DSR_FLOW_CONTROL) - data->flow |= DSR_FLOW; -#else - /* DTR/DSR flow control not supported. */ - if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL) - return SP_ERR_ARG; - - if (config->dtr >= 0) { - controlbits = TIOCM_DTR; - if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, - &controlbits) < 0) - return SP_ERR_FAIL; - } -#endif } if (config->xon_xoff >= 0) { @@ -1196,33 +2138,92 @@ static enum sp_return set_config(struct sp_port *port, struct port_data *data, data->term.c_iflag |= IXON | IXOFF | IXANY; break; default: - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting"); } } - if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0) - return SP_ERR_FAIL; + if (tcsetattr(port->fd, TCSANOW, &data->term) < 0) + RETURN_FAIL("tcsetattr() failed"); #ifdef __APPLE__ if (baud_nonstd != B0) { if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1) - return SP_ERR_FAIL; + RETURN_FAIL("IOSSIOSPEED ioctl failed"); /* Set baud rates in data->term to correct, but incompatible * with tcsetattr() value, same as delivered by tcgetattr(). */ if (cfsetspeed(&data->term, baud_nonstd) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("cfsetspeed() failed"); } #elif defined(__linux__) +#ifdef USE_TERMIOS_SPEED if (baud_nonstd) TRY(set_baudrate(port->fd, config->baudrate)); +#endif #ifdef USE_TERMIOX - TRY(set_flow(port->fd, data->flow)); + if (data->termiox_supported) + TRY(set_flow(port->fd, data)); #endif #endif #endif /* !_WIN32 */ - return SP_OK; + RETURN_OK(); +} + +enum sp_return sp_new_config(struct sp_port_config **config_ptr) +{ + struct sp_port_config *config; + + TRACE("%p", config_ptr); + + if (!config_ptr) + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); + + *config_ptr = NULL; + + if (!(config = malloc(sizeof(struct sp_port_config)))) + RETURN_ERROR(SP_ERR_MEM, "config malloc failed"); + + config->baudrate = -1; + config->bits = -1; + config->parity = -1; + config->stopbits = -1; + config->rts = -1; + config->cts = -1; + config->dtr = -1; + config->dsr = -1; + + *config_ptr = config; + + RETURN_OK(); +} + +void sp_free_config(struct sp_port_config *config) +{ + TRACE("%p", config); + + if (!config) + DEBUG("Null config"); + else + free(config); + + RETURN(); +} + +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 config"); + + TRY(get_config(port, &data, config)); + + RETURN_OK(); } enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config) @@ -1230,98 +2231,135 @@ enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config * struct port_data data; struct sp_port_config prev_config; - CHECK_PORT(); + TRACE("%p, %p", port, config); + + CHECK_OPEN_PORT(); if (!config) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null config"); TRY(get_config(port, &data, &prev_config)); TRY(set_config(port, &data, config)); - return SP_OK; + RETURN_OK(); } -#define CREATE_SETTER(x, type) int sp_set_##x(struct sp_port *port, type x) { \ +#define CREATE_ACCESSORS(x, type) \ +enum sp_return sp_set_##x(struct sp_port *port, type x) { \ struct port_data data; \ struct sp_port_config config; \ - CHECK_PORT(); \ + TRACE("%p, %d", port, x); \ + CHECK_OPEN_PORT(); \ TRY(get_config(port, &data, &config)); \ config.x = x; \ TRY(set_config(port, &data, &config)); \ - return SP_OK; \ + RETURN_OK(); \ +} \ +enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \ + TRACE("%p, %p", config, x); \ + if (!config) \ + RETURN_ERROR(SP_ERR_ARG, "Null config"); \ + *x = config->x; \ + RETURN_OK(); \ +} \ +enum sp_return sp_set_config_##x(struct sp_port_config *config, type x) { \ + TRACE("%p, %d", config, x); \ + if (!config) \ + RETURN_ERROR(SP_ERR_ARG, "Null config"); \ + config->x = x; \ + RETURN_OK(); \ } -CREATE_SETTER(baudrate, int) -CREATE_SETTER(bits, int) -CREATE_SETTER(parity, enum sp_parity) -CREATE_SETTER(stopbits, int) -CREATE_SETTER(rts, enum sp_rts) -CREATE_SETTER(cts, enum sp_cts) -CREATE_SETTER(dtr, enum sp_dtr) -CREATE_SETTER(dsr, enum sp_dsr) -CREATE_SETTER(xon_xoff, enum sp_xonxoff) - -enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol) +CREATE_ACCESSORS(baudrate, int) +CREATE_ACCESSORS(bits, int) +CREATE_ACCESSORS(parity, enum sp_parity) +CREATE_ACCESSORS(stopbits, int) +CREATE_ACCESSORS(rts, enum sp_rts) +CREATE_ACCESSORS(cts, enum sp_cts) +CREATE_ACCESSORS(dtr, enum sp_dtr) +CREATE_ACCESSORS(dsr, enum sp_dsr) +CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff) + +enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol) { - struct port_data data; - struct sp_port_config config; - - CHECK_PORT(); + if (!config) + RETURN_ERROR(SP_ERR_ARG, "Null configuration"); - TRY(get_config(port, &data, &config)); + if (flowcontrol > SP_FLOWCONTROL_DTRDSR) + RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting"); if (flowcontrol == SP_FLOWCONTROL_XONXOFF) - config.xon_xoff = SP_XONXOFF_INOUT; + config->xon_xoff = SP_XONXOFF_INOUT; else - config.xon_xoff = SP_XONXOFF_DISABLED; + config->xon_xoff = SP_XONXOFF_DISABLED; if (flowcontrol == SP_FLOWCONTROL_RTSCTS) { - config.rts = SP_RTS_FLOW_CONTROL; - config.cts = SP_CTS_FLOW_CONTROL; + config->rts = SP_RTS_FLOW_CONTROL; + config->cts = SP_CTS_FLOW_CONTROL; } else { - if (config.rts == SP_RTS_FLOW_CONTROL) - config.rts = SP_RTS_ON; - config.cts = SP_CTS_IGNORE; + if (config->rts == SP_RTS_FLOW_CONTROL) + config->rts = SP_RTS_ON; + config->cts = SP_CTS_IGNORE; } if (flowcontrol == SP_FLOWCONTROL_DTRDSR) { - config.dtr = SP_DTR_FLOW_CONTROL; - config.dsr = SP_DSR_FLOW_CONTROL; + config->dtr = SP_DTR_FLOW_CONTROL; + config->dsr = SP_DSR_FLOW_CONTROL; } else { - if (config.dtr == SP_DTR_FLOW_CONTROL) - config.dtr = SP_DTR_ON; - config.dsr = SP_DSR_IGNORE; + if (config->dtr == SP_DTR_FLOW_CONTROL) + config->dtr = SP_DTR_ON; + config->dsr = SP_DSR_IGNORE; } + RETURN_OK(); +} + +enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol) +{ + struct port_data data; + struct sp_port_config config; + + TRACE("%p, %d", port, flowcontrol); + + CHECK_OPEN_PORT(); + + TRY(get_config(port, &data, &config)); + + TRY(sp_set_config_flowcontrol(&config, flowcontrol)); + TRY(set_config(port, &data, &config)); - return SP_OK; + RETURN_OK(); } enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals) { - CHECK_PORT(); + TRACE("%p, %p", port, signals); + + CHECK_OPEN_PORT(); if (!signals) - return SP_ERR_ARG; + RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); + + DEBUG("Getting control signals for port %s", port->name); *signals = 0; #ifdef _WIN32 DWORD bits; if (GetCommModemStatus(port->hdl, &bits) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("GetCommModemStatus() failed"); if (bits & MS_CTS_ON) *signals |= SP_SIG_CTS; if (bits & MS_DSR_ON) *signals |= SP_SIG_DSR; - if (bits & MS_RING_ON) - *signals |= SP_SIG_DCD; if (bits & MS_RLSD_ON) + *signals |= SP_SIG_DCD; + if (bits & MS_RING_ON) *signals |= SP_SIG_RI; #else int bits; if (ioctl(port->fd, TIOCMGET, &bits) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("TIOCMGET ioctl failed"); if (bits & TIOCM_CTS) *signals |= SP_SIG_CTS; if (bits & TIOCM_DSR) @@ -1331,48 +2369,55 @@ enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals) if (bits & TIOCM_RNG) *signals |= SP_SIG_RI; #endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_start_break(struct sp_port *port) { - CHECK_PORT(); + TRACE("%p", port); + + CHECK_OPEN_PORT(); #ifdef _WIN32 if (SetCommBreak(port->hdl) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("SetCommBreak() failed"); #else if (ioctl(port->fd, TIOCSBRK, 1) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("TIOCSBRK ioctl failed"); #endif - return SP_OK; + RETURN_OK(); } enum sp_return sp_end_break(struct sp_port *port) { - CHECK_PORT(); + TRACE("%p", port); + + CHECK_OPEN_PORT(); #ifdef _WIN32 if (ClearCommBreak(port->hdl) == 0) - return SP_ERR_FAIL; + RETURN_FAIL("ClearCommBreak() failed"); #else if (ioctl(port->fd, TIOCCBRK, 1) < 0) - return SP_ERR_FAIL; + RETURN_FAIL("TIOCCBRK ioctl failed"); #endif - return SP_OK; + RETURN_OK(); } int sp_last_error_code(void) { + TRACE(""); #ifdef _WIN32 - return GetLastError(); + RETURN_VALUE("%d", GetLastError()); #else - return errno; + RETURN_VALUE("%d", errno); #endif } char *sp_last_error_message(void) { + TRACE(""); + #ifdef _WIN32 LPVOID message; DWORD error = GetLastError(); @@ -1387,17 +2432,83 @@ char *sp_last_error_message(void) (LPTSTR) &message, 0, NULL ); - return message; + RETURN_VALUE("%s", message); #else - return strerror(errno); + RETURN_VALUE("%s", strerror(errno)); #endif } void sp_free_error_message(char *message) { + TRACE("%s", message); + #ifdef _WIN32 LocalFree(message); #else (void)message; #endif + + RETURN(); +} + +void sp_set_debug_handler(void (*handler)(const char *format, ...)) +{ + TRACE("%p", handler); + + sp_debug_handler = handler; + + RETURN(); +} + +void sp_default_debug_handler(const char *format, ...) +{ + va_list args; + va_start(args, format); + if (getenv("LIBSERIALPORT_DEBUG")) { + fputs("sp: ", stderr); + vfprintf(stderr, format, args); + } + 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; +} + +/** @} */