libserialport/serialport.c

1925 lines
44 KiB
C
Raw Normal View History

/*
* This file is part of the libserialport project.
*
* Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
* Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
* Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
* Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
2013-04-28 14:56:06 +04:00
#include <stdlib.h>
#include <errno.h>
#include <stdio.h>
#include <stdarg.h>
#ifdef _WIN32
#include <windows.h>
2013-04-28 14:56:06 +04:00
#include <tchar.h>
#include <stdio.h>
#else
#include <limits.h>
#include <termios.h>
#include <sys/ioctl.h>
#endif
2013-04-28 14:56:06 +04:00
#ifdef __APPLE__
2013-11-02 23:14:36 +04:00
#include <IOKit/IOKitLib.h>
#include <IOKit/serial/IOSerialKeys.h>
#include <IOKit/serial/ioss.h>
2013-11-02 23:14:36 +04:00
#include <sys/syslimits.h>
2013-04-28 14:56:06 +04:00
#endif
#ifdef __linux__
#include "libudev.h"
#include "linux/serial.h"
2013-11-21 04:35:51 +04:00
#include "linux_termios.h"
#if defined(TCGETX) && defined(TCSETX) && defined(HAVE_TERMIOX)
2013-11-22 23:00:24 +04:00
#define USE_TERMIOX
#endif
2013-04-28 14:56:06 +04:00
#endif
#ifndef _WIN32
#include "linux_termios.h"
#endif
2013-11-04 16:53:12 +04:00
#include "libserialport.h"
2013-11-23 21:11:19 +04:00
struct sp_port {
char *name;
int nonblocking;
2013-11-23 21:11:19 +04:00
#ifdef _WIN32
HANDLE hdl;
2013-11-25 15:47:19 +04:00
OVERLAPPED write_ovl;
BYTE pending_byte;
2013-11-25 15:47:19 +04:00
BOOL writing;
2013-11-23 21:11:19 +04:00
#else
int fd;
#endif
};
2013-11-24 00:41:01 +04:00
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;
2013-11-22 23:00:24 +04:00
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;
};
const struct std_baudrate std_baudrates[] = {
#ifdef _WIN32
/*
* The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
* have documented CBR_* macros.
*/
BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
BAUD(115200), BAUD(128000), BAUD(256000),
#else
BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
BAUD(230400),
#if !defined(__APPLE__) && !defined(__OpenBSD__)
BAUD(460800),
#endif
#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)
2013-11-23 02:44:19 +04:00
/* Debug output macros. */
#define DEBUG(fmt, ...) do { if (sp_debug_handler) sp_debug_handler(fmt ".\n", ##__VA_ARGS__); } while (0)
#define DEBUG_ERROR(err, msg) DEBUG("%s returning " #err ": " msg, __func__)
#define DEBUG_FAIL(msg) do { \
char *errmsg = sp_last_error_message(); \
DEBUG("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \
sp_free_error_message(errmsg); \
} while (0);
#define RETURN() do { DEBUG("%s returning", __func__); return; } while(0)
#define RETURN_CODE(x) do { DEBUG("%s returning " #x, __func__); return x; } while (0)
#define RETURN_CODEVAL(x) do { \
switch (x) { \
case SP_OK: RETURN_CODE(SP_OK); \
case SP_ERR_ARG: RETURN_CODE(SP_ERR_ARG); \
case SP_ERR_FAIL: RETURN_CODE(SP_ERR_FAIL); \
case SP_ERR_MEM: RETURN_CODE(SP_ERR_MEM); \
case SP_ERR_SUPP: RETURN_CODE(SP_ERR_SUPP); \
} \
} while (0)
#define RETURN_OK() RETURN_CODE(SP_OK);
#define RETURN_ERROR(err, msg) do { DEBUG_ERROR(err, msg); return err; } while (0)
#define RETURN_FAIL(msg) do { DEBUG_FAIL(msg); return SP_ERR_FAIL; } while (0)
#define RETURN_VALUE(fmt, x) do { DEBUG("%s returning " fmt, __func__, x); return x; } while (0)
#define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0)
2013-11-25 15:34:42 +04:00
#define SET_FAIL(val, msg) do { DEBUG_FAIL(msg); val = SP_ERR_FAIL; } while (0)
2013-11-23 02:44:19 +04:00
#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)
2013-11-19 00:02:30 +04:00
/* 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;
int len;
TRACE("%s, %p", portname, port_ptr);
2013-11-04 17:42:55 +04:00
if (!port_ptr)
RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2013-11-04 17:42:55 +04:00
*port_ptr = NULL;
2013-11-04 01:35:46 +04:00
if (!portname)
RETURN_ERROR(SP_ERR_ARG, "Null port name");
2013-11-04 01:35:46 +04:00
2013-11-23 05:08:57 +04:00
DEBUG("Building structure for port %s", portname);
if (!(port = malloc(sizeof(struct sp_port))))
RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
len = strlen(portname) + 1;
if (!(port->name = malloc(len))) {
free(port);
RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
}
memcpy(port->name, portname, len);
#ifdef _WIN32
port->hdl = INVALID_HANDLE_VALUE;
#else
port->fd = -1;
#endif
*port_ptr = port;
RETURN_OK();
}
2013-11-23 21:11:19 +04:00
char *sp_get_port_name(const struct sp_port *port)
{
TRACE("%p", port);
if (!port)
return NULL;
RETURN_VALUE("%s", port->name);
}
2013-11-23 21:50:45 +04:00
enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr)
{
2013-11-26 19:12:20 +04:00
TRACE("%p, %p", port, result_ptr);
2013-11-23 21:50:45 +04:00
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)
2013-11-04 17:42:55 +04:00
{
TRACE("%p, %p", port, copy_ptr);
2013-11-04 17:42:55 +04:00
if (!copy_ptr)
RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2013-11-04 17:42:55 +04:00
*copy_ptr = NULL;
if (!port)
RETURN_ERROR(SP_ERR_ARG, "Null port");
if (!port->name)
RETURN_ERROR(SP_ERR_ARG, "Null port name");
2013-11-04 17:42:55 +04:00
2013-11-23 05:08:57 +04:00
DEBUG("Copying port structure");
RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr));
2013-11-04 17:42:55 +04:00
}
2013-11-04 02:27:59 +04:00
void sp_free_port(struct sp_port *port)
{
TRACE("%p", port);
2013-11-26 19:12:20 +04:00
if (!port) {
DEBUG("Null port");
RETURN();
}
2013-11-04 02:27:59 +04:00
2013-11-23 05:08:57 +04:00
DEBUG("Freeing port structure");
2013-11-04 02:27:59 +04:00
if (port->name)
free(port->name);
free(port);
RETURN();
2013-11-04 02:27:59 +04:00
}
2013-11-19 00:02:30 +04:00
static struct sp_port **list_append(struct sp_port **list, const char *portname)
2013-04-28 14:56:06 +04:00
{
void *tmp;
unsigned int count;
2013-11-14 20:33:53 +04:00
2013-04-28 14:56:06 +04:00
for (count = 0; list[count]; count++);
if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
2013-04-28 14:56:06 +04:00
goto fail;
list = tmp;
if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
2013-04-28 14:56:06 +04:00
goto fail;
2013-05-08 05:55:43 +04:00
list[count + 1] = NULL;
2013-04-28 14:56:06 +04:00
return list;
2013-11-14 20:33:53 +04:00
2013-04-28 14:56:06 +04:00
fail:
sp_free_port_list(list);
return NULL;
}
enum sp_return sp_list_ports(struct sp_port ***list_ptr)
2013-04-28 14:56:06 +04:00
{
struct sp_port **list;
int ret = SP_ERR_SUPP;
TRACE("%p", list_ptr);
2013-11-23 15:39:59 +04:00
if (!list_ptr)
RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2013-11-23 05:08:57 +04:00
DEBUG("Enumerating ports");
if (!(list = malloc(sizeof(struct sp_port **))))
RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
list[0] = NULL;
2013-04-28 14:56:06 +04:00
#ifdef _WIN32
HKEY key;
TCHAR *value, *data;
DWORD max_value_len, max_data_size, max_data_len;
DWORD value_len, data_size, data_len;
2013-04-28 14:56:06 +04:00
DWORD type, index = 0;
char *name;
int name_len;
2013-04-28 14:56:06 +04:00
ret = SP_OK;
2013-11-23 05:08:57 +04:00
DEBUG("Opening registry key");
2013-04-28 14:56:06 +04:00
if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) {
SET_FAIL(ret, "RegOpenKeyEx() failed");
goto out_done;
}
2013-11-23 05:08:57 +04:00
DEBUG("Querying registry key value and data sizes");
2013-04-28 14:56:06 +04:00
if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
&max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) {
SET_FAIL(ret, "RegQueryInfoKey() failed");
2013-04-28 14:56:06 +04:00
goto out_close;
}
2013-04-28 14:56:06 +04:00
max_data_len = max_data_size / sizeof(TCHAR);
if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) {
SET_ERROR(ret, SP_ERR_MEM, "registry value malloc failed");
2013-04-28 14:56:06 +04:00
goto out_close;
}
if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) {
SET_ERROR(ret, SP_ERR_MEM, "registry data malloc failed");
goto out_free_value;
}
2013-11-23 05:08:57 +04:00
DEBUG("Iterating over values");
2013-04-28 14:56:06 +04:00
while (
2013-11-04 06:16:21 +04:00
value_len = max_value_len + 1,
2013-04-28 14:56:06 +04:00
data_size = max_data_size,
RegEnumValue(key, index, value, &value_len,
2013-04-28 14:56:06 +04:00
NULL, &type, (LPBYTE)data, &data_size) == ERROR_SUCCESS)
{
data_len = data_size / sizeof(TCHAR);
data[data_len] = '\0';
#ifdef UNICODE
name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
#else
name_len = data_len + 1;
#endif
if (!(name = malloc(name_len))) {
SET_ERROR(ret, SP_ERR_MEM, "registry port name malloc failed");
goto out;
}
#ifdef UNICODE
WideCharToMultiByte(CP_ACP, 0, data, -1, name, name_len, NULL, NULL);
#else
strcpy(name, data);
#endif
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;
}
}
2013-04-28 14:56:06 +04:00
index++;
}
out:
free(data);
out_free_value:
free(value);
2013-04-28 14:56:06 +04:00
out_close:
RegCloseKey(key);
out_done:
2013-04-28 14:56:06 +04:00
#endif
#ifdef __APPLE__
mach_port_t master;
CFMutableDictionaryRef classes;
io_iterator_t iter;
char *path;
io_object_t port;
CFTypeRef cf_path;
Boolean result;
ret = SP_OK;
2013-11-23 05:08:57 +04:00
DEBUG("Getting IOKit master port");
if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) {
SET_FAIL(ret, "IOMasterPort() failed");
goto out_done;
}
2013-04-28 14:56:06 +04:00
2013-11-23 05:08:57 +04:00
DEBUG("Creating matching dictionary");
if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) {
SET_FAIL(ret, "IOServiceMatching() failed");
goto out_done;
}
2013-04-28 14:56:06 +04:00
CFDictionarySetValue(classes,
CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
2013-11-23 05:08:57 +04:00
DEBUG("Getting matching services");
if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS) {
SET_FAIL(ret, "IOServiceGetMatchingServices() failed");
goto out_done;
}
2013-04-28 14:56:06 +04:00
if (!(path = malloc(PATH_MAX))) {
SET_ERROR(ret, SP_ERR_MEM, "device path malloc failed");
2013-04-28 14:56:06 +04:00
goto out_release;
}
2013-04-28 14:56:06 +04:00
2013-11-23 05:08:57 +04:00
DEBUG("Iterating over results");
2013-11-02 23:14:36 +04:00
while ((port = IOIteratorNext(iter))) {
2013-04-28 14:56:06 +04:00
cf_path = IORegistryEntryCreateCFProperty(port,
CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
if (cf_path) {
result = CFStringGetCString(cf_path,
path, PATH_MAX, kCFStringEncodingASCII);
CFRelease(cf_path);
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;
}
}
2013-04-28 14:56:06 +04:00
}
IOObjectRelease(port);
}
out:
free(path);
out_release:
IOObjectRelease(iter);
out_done:
2013-04-28 14:56:06 +04:00
#endif
#ifdef __linux__
struct udev *ud;
struct udev_enumerate *ud_enumerate;
struct udev_list_entry *ud_list;
struct udev_list_entry *ud_entry;
const char *path;
struct udev_device *ud_dev, *ud_parent;
2013-04-28 14:56:06 +04:00
const char *name;
const char *driver;
int fd, ioctl_result;
struct serial_struct serial_info;
2013-04-28 14:56:06 +04:00
ret = SP_OK;
2013-11-23 05:08:57 +04:00
DEBUG("Enumerating tty devices");
2013-04-28 14:56:06 +04:00
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);
2013-11-23 05:08:57 +04:00
DEBUG("Iterating over results");
udev_list_entry_foreach(ud_entry, ud_list) {
2013-04-28 14:56:06 +04:00
path = udev_list_entry_get_name(ud_entry);
2013-11-23 05:08:57 +04:00
DEBUG("Found device %s", path);
2013-04-28 14:56:06 +04:00
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) {
2013-11-23 05:08:57 +04:00
DEBUG("No parent device, assuming virtual tty");
udev_device_unref(ud_dev);
continue;
}
2013-04-28 14:56:06 +04:00
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")) {
2013-11-23 05:08:57 +04:00
DEBUG("serial8250 device, attempting to open");
if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) {
DEBUG("open failed, skipping");
goto skip;
2013-11-23 05:08:57 +04:00
}
ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
close(fd);
2013-11-23 05:08:57 +04:00
if (ioctl_result != 0) {
DEBUG("ioctl failed, skipping");
goto skip;
2013-11-23 05:08:57 +04:00
}
if (serial_info.type == PORT_UNKNOWN) {
DEBUG("port type is unknown, skipping");
goto skip;
2013-11-23 05:08:57 +04:00
}
}
DEBUG("Found port %s", name);
2013-11-19 00:02:30 +04:00
list = list_append(list, name);
skip:
2013-04-28 14:56:06 +04:00
udev_device_unref(ud_dev);
if (!list) {
SET_ERROR(ret, SP_ERR_MEM, "list append failed");
2013-04-28 14:56:06 +04:00
goto out;
}
2013-04-28 14:56:06 +04:00
}
out:
udev_enumerate_unref(ud_enumerate);
udev_unref(ud);
#endif
switch (ret) {
case SP_OK:
*list_ptr = list;
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;
}
2013-04-28 14:56:06 +04:00
}
void sp_free_port_list(struct sp_port **list)
2013-04-28 14:56:06 +04:00
{
unsigned int i;
2013-11-14 20:33:53 +04:00
TRACE("%p", list);
2013-11-23 15:39:59 +04:00
if (!list) {
DEBUG("Null list");
RETURN();
}
2013-11-23 05:08:57 +04:00
DEBUG("Freeing port list");
2013-04-28 14:56:06 +04:00
for (i = 0; list[i]; i++)
2013-11-04 02:27:59 +04:00
sp_free_port(list[i]);
2013-04-28 14:56:06 +04:00
free(list);
RETURN();
2013-04-28 14:56:06 +04:00
}
#define CHECK_PORT() do { \
if (port == NULL) \
RETURN_ERROR(SP_ERR_ARG, "Null port"); \
2013-11-23 15:39:59 +04:00
if (port->name == NULL) \
RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
} while (0)
#ifdef _WIN32
#define CHECK_PORT_HANDLE() do { \
if (port->hdl == INVALID_HANDLE_VALUE) \
RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
2013-11-23 15:39:59 +04:00
} while (0)
#else
2013-11-23 15:39:59 +04:00
#define CHECK_PORT_HANDLE() do { \
if (port->fd < 0) \
RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
2013-11-23 15:39:59 +04:00
} while (0)
#endif
2013-11-23 15:39:59 +04:00
#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)
{
struct port_data data;
struct sp_port_config config;
enum sp_return ret;
2013-11-26 19:12:20 +04:00
TRACE("%p, 0x%x", port, flags);
2013-11-23 15:39:59 +04:00
CHECK_PORT();
if (flags > (SP_MODE_READ | SP_MODE_WRITE | SP_MODE_NONBLOCK))
RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
2013-11-23 05:08:57 +04:00
DEBUG("Opening port %s", port->name);
port->nonblocking = (flags & SP_MODE_NONBLOCK) ? 1 : 0;
#ifdef _WIN32
DWORD desired_access = 0, flags_and_attributes = 0;
2013-11-25 15:47:19 +04:00
COMMTIMEOUTS timeouts;
char *escaped_port_name;
/* Prefix port name with '\\.\' to work with ports above COM9. */
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;
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);
free(escaped_port_name);
if (port->hdl == INVALID_HANDLE_VALUE)
RETURN_FAIL("CreateFile() failed");
2013-11-25 15:47:19 +04:00
/* All timeouts disabled. */
timeouts.ReadIntervalTimeout = 0;
timeouts.ReadTotalTimeoutMultiplier = 0;
timeouts.ReadTotalTimeoutConstant = 0;
timeouts.WriteTotalTimeoutMultiplier = 0;
timeouts.WriteTotalTimeoutConstant = 0;
if (port->nonblocking) {
/* Set read timeout such that all reads return immediately. */
timeouts.ReadIntervalTimeout = MAXDWORD;
/* Prepare OVERLAPPED structure for non-blocking writes. */
memset(&port->write_ovl, 0, sizeof(port->write_ovl));
if (!(port->write_ovl.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL))) {
sp_close(port);
RETURN_FAIL("CreateEvent() failed");
}
port->writing = FALSE;
}
if (SetCommTimeouts(port->hdl, &timeouts) == 0) {
sp_close(port);
RETURN_FAIL("SetCommTimeouts() failed");
}
#else
int flags_local = 0;
2013-11-14 20:33:53 +04:00
/* Map 'flags' to the OS-specific settings. */
if (flags & (SP_MODE_READ | SP_MODE_WRITE))
flags_local |= O_RDWR;
else if (flags & SP_MODE_READ)
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_FAIL("open() failed");
#endif
2013-11-18 23:52:37 +04:00
ret = get_config(port, &data, &config);
if (ret < 0) {
2013-11-18 23:52:37 +04:00
sp_close(port);
RETURN_CODEVAL(ret);
2013-11-18 23:52:37 +04:00
}
/* 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
data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
data.term.c_cc[VMIN] = 1;
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
2013-11-18 23:52:37 +04:00
ret = set_config(port, &data, &config);
if (ret < 0) {
2013-11-18 23:52:37 +04:00
sp_close(port);
RETURN_CODEVAL(ret);
2013-11-18 23:52:37 +04:00
}
RETURN_OK();
}
enum sp_return sp_close(struct sp_port *port)
{
TRACE("%p", port);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
2013-11-23 05:08:57 +04:00
DEBUG("Closing port %s", port->name);
#ifdef _WIN32
/* Returns non-zero upon success, 0 upon failure. */
if (CloseHandle(port->hdl) == 0)
RETURN_FAIL("CloseHandle() failed");
port->hdl = INVALID_HANDLE_VALUE;
2013-11-25 15:47:19 +04:00
if (port->nonblocking) {
/* Close event handle created for overlapped writes. */
if (CloseHandle(port->write_ovl.hEvent) == 0)
RETURN_FAIL("CloseHandle() failed");
}
#else
/* Returns 0 upon success, -1 upon failure. */
if (close(port->fd) == -1)
RETURN_FAIL("close() failed");
port->fd = -1;
#endif
RETURN_OK();
}
enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
{
2013-11-26 19:12:20 +04:00
TRACE("%p, 0x%x", port, buffers);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
if (buffers > SP_BUF_BOTH)
RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
const char *buffer_names[] = {"no", "input", "output", "both"};
2013-11-23 05:08:57 +04:00
DEBUG("Flushing %s buffers on port %s", buffer_names[buffers], port->name);
#ifdef _WIN32
DWORD flags = 0;
if (buffers & SP_BUF_INPUT)
flags |= PURGE_RXCLEAR;
if (buffers & SP_BUF_OUTPUT)
flags |= PURGE_TXCLEAR;
/* 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;
2013-11-21 21:22:16 +04:00
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();
}
2013-11-20 21:30:50 +04:00
enum sp_return sp_drain(struct sp_port *port)
{
TRACE("%p", port);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
2013-11-20 21:30:50 +04:00
2013-11-23 05:08:57 +04:00
DEBUG("Draining port %s", port->name);
2013-11-20 21:30:50 +04:00
#ifdef _WIN32
/* Returns non-zero upon success, 0 upon failure. */
if (FlushFileBuffers(port->hdl) == 0)
RETURN_FAIL("FlushFileBuffers() failed");
2013-11-20 21:30:50 +04:00
#else
/* Returns 0 upon success, -1 upon failure. */
if (tcdrain(port->fd) < 0)
RETURN_FAIL("tcdrain() failed");
2013-11-20 21:30:50 +04:00
#endif
RETURN_OK();
2013-11-20 21:30:50 +04:00
}
enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count)
{
TRACE("%p, %p, %d", port, buf, count);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
if (!buf)
RETURN_ERROR(SP_ERR_ARG, "Null buffer");
2013-11-23 05:08:57 +04:00
DEBUG("Writing up to %d bytes to port %s", count, port->name);
2013-11-25 15:47:19 +04:00
if (count == 0)
RETURN_VALUE("0", 0);
#ifdef _WIN32
DWORD written = 0;
BYTE *ptr = (BYTE *) buf;
2013-11-14 20:33:53 +04:00
2013-11-25 15:47:19 +04:00
if (port->nonblocking) {
/* Non-blocking write. */
/* 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);
}
}
/* 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) {
DEBUG("Asynchronous write started");
port->writing = 1;
RETURN_VALUE("%d", ++written);
} else {
/* Actual failure of some kind. */
RETURN_FAIL("WriteFile() failed");
}
2013-11-25 15:47:19 +04:00
} else {
DEBUG("Single byte written immediately.");
written++;
2013-11-25 15:47:19 +04:00
}
}
DEBUG("All bytes written immediately.");
2013-11-25 15:47:19 +04:00
} else {
/* Blocking write. */
if (WriteFile(port->hdl, buf, count, &written, NULL) == 0) {
RETURN_FAIL("WriteFile() failed");
}
}
RETURN_VALUE("%d", written);
#else
/* Returns the number of bytes written, or -1 upon failure. */
ssize_t written = write(port->fd, buf, count);
2013-11-14 20:33:53 +04:00
if (written < 0)
RETURN_FAIL("write() failed");
else
RETURN_VALUE("%d", written);
#endif
}
enum sp_return sp_read(struct sp_port *port, void *buf, size_t count)
{
TRACE("%p, %p, %d", port, buf, count);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
if (!buf)
RETURN_ERROR(SP_ERR_ARG, "Null buffer");
2013-11-23 05:08:57 +04:00
DEBUG("Reading up to %d bytes from port %s", count, port->name);
#ifdef _WIN32
DWORD bytes_read = 0;
2013-11-14 20:33:53 +04:00
/* Returns non-zero upon success, 0 upon failure. */
if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0)
RETURN_FAIL("ReadFile() failed");
RETURN_VALUE("%d", bytes_read);
#else
ssize_t bytes_read;
2013-11-14 20:33:53 +04:00
/* Returns the number of bytes read, or -1 upon failure. */
if ((bytes_read = read(port->fd, buf, count)) < 0) {
if (port->nonblocking && errno == EAGAIN)
/* Port is opened in nonblocking mode and there are no bytes available. */
bytes_read = 0;
else
/* This is an actual failure. */
RETURN_FAIL("read() failed");
}
RETURN_VALUE("%d", bytes_read);
#endif
}
2013-11-21 04:35:51 +04:00
#ifdef __linux__
static enum sp_return get_baudrate(int fd, int *baudrate)
{
void *data;
TRACE("%d, %p", fd, baudrate);
2013-11-23 05:08:57 +04:00
DEBUG("Getting baud rate");
2013-11-21 04:35:51 +04:00
if (!(data = malloc(get_termios_size())))
RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
2013-11-21 04:35:51 +04:00
2013-11-22 22:43:41 +04:00
if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
free(data);
RETURN_FAIL("getting termios failed");
2013-11-22 22:43:41 +04:00
}
2013-11-21 04:35:51 +04:00
*baudrate = get_termios_speed(data);
2013-11-22 22:43:41 +04:00
free(data);
RETURN_OK();
2013-11-21 04:35:51 +04:00
}
static enum sp_return set_baudrate(int fd, int baudrate)
{
void *data;
TRACE("%d, %d", fd, baudrate);
2013-11-23 05:08:57 +04:00
DEBUG("Getting baud rate");
2013-11-21 04:35:51 +04:00
if (!(data = malloc(get_termios_size())))
RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
2013-11-21 04:35:51 +04:00
2013-11-22 22:43:41 +04:00
if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
free(data);
RETURN_FAIL("getting termios failed");
2013-11-22 22:43:41 +04:00
}
2013-11-21 04:35:51 +04:00
2013-11-23 05:08:57 +04:00
DEBUG("Setting baud rate");
2013-11-21 04:35:51 +04:00
set_termios_speed(data, baudrate);
2013-11-22 22:43:41 +04:00
if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
free(data);
RETURN_FAIL("setting termios failed");
2013-11-22 22:43:41 +04:00
}
free(data);
2013-11-21 04:35:51 +04:00
RETURN_OK();
2013-11-21 04:35:51 +04:00
}
#ifdef USE_TERMIOX
static enum sp_return get_flow(int fd, int *flow)
{
void *data;
TRACE("%d, %p", fd, flow);
2013-11-23 05:08:57 +04:00
DEBUG("Getting advanced flow control");
if (!(data = malloc(get_termiox_size())))
RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
2013-11-22 22:43:41 +04:00
if (ioctl(fd, TCGETX, data) < 0) {
free(data);
RETURN_FAIL("getting termiox failed");
2013-11-22 22:43:41 +04:00
}
*flow = get_termiox_flow(data);
2013-11-22 22:43:41 +04:00
free(data);
RETURN_OK();
}
static enum sp_return set_flow(int fd, int flow)
{
void *data;
TRACE("%d, %d", fd, flow);
2013-11-23 05:08:57 +04:00
DEBUG("Getting advanced flow control");
if (!(data = malloc(get_termiox_size())))
RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
2013-11-22 22:43:41 +04:00
if (ioctl(fd, TCGETX, data) < 0) {
free(data);
RETURN_FAIL("getting termiox failed");
2013-11-22 22:43:41 +04:00
}
2013-11-23 05:08:57 +04:00
DEBUG("Setting advanced flow control");
set_termiox_flow(data, flow);
2013-11-22 22:43:41 +04:00
if (ioctl(fd, TCSETX, data) < 0) {
free(data);
RETURN_FAIL("setting termiox failed");
2013-11-22 22:43:41 +04:00
}
free(data);
RETURN_OK();
}
#endif /* USE_TERMIOX */
#endif /* __linux__ */
2013-11-21 04:35:51 +04:00
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);
2013-11-23 05:08:57 +04:00
DEBUG("Getting configuration for port %s", port->name);
#ifdef _WIN32
2013-11-18 23:52:37 +04:00
if (!GetCommState(port->hdl, &data->dcb))
RETURN_FAIL("GetCommState() failed");
2013-11-17 00:55:53 +04:00
for (i = 0; i < NUM_STD_BAUDRATES; i++) {
2013-11-18 23:52:37 +04:00
if (data->dcb.BaudRate == std_baudrates[i].index) {
2013-11-17 00:55:53 +04:00
config->baudrate = std_baudrates[i].value;
break;
}
}
if (i == NUM_STD_BAUDRATES)
/* BaudRate field can be either an index or a custom baud rate. */
2013-11-18 23:52:37 +04:00
config->baudrate = data->dcb.BaudRate;
2013-11-17 00:55:53 +04:00
2013-11-18 23:52:37 +04:00
config->bits = data->dcb.ByteSize;
2013-11-17 00:55:53 +04:00
2013-11-18 23:52:37 +04:00
if (data->dcb.fParity)
switch (data->dcb.Parity) {
2013-11-17 00:55:53 +04:00
case NOPARITY:
config->parity = SP_PARITY_NONE;
break;
2013-11-25 22:05:58 +04:00
case ODDPARITY:
config->parity = SP_PARITY_ODD;
break;
2013-11-17 00:55:53 +04:00
case EVENPARITY:
config->parity = SP_PARITY_EVEN;
break;
2013-11-25 22:05:58 +04:00
case MARKPARITY:
config->parity = SP_PARITY_MARK;
break;
case SPACEPARITY:
config->parity = SP_PARITY_SPACE;
2013-11-17 00:55:53 +04:00
break;
default:
config->parity = -1;
}
else
config->parity = SP_PARITY_NONE;
2013-11-18 23:52:37 +04:00
switch (data->dcb.StopBits) {
2013-11-17 00:55:53 +04:00
case ONESTOPBIT:
config->stopbits = 1;
break;
case TWOSTOPBITS:
config->stopbits = 2;
break;
default:
config->stopbits = -1;
}
2013-11-18 23:52:37 +04:00
switch (data->dcb.fRtsControl) {
case RTS_CONTROL_DISABLE:
config->rts = SP_RTS_OFF;
break;
case RTS_CONTROL_ENABLE:
config->rts = SP_RTS_ON;
break;
case RTS_CONTROL_HANDSHAKE:
config->rts = SP_RTS_FLOW_CONTROL;
break;
default:
config->rts = -1;
2013-11-17 00:55:53 +04:00
}
2013-11-18 23:52:37 +04:00
config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
2013-11-17 00:55:53 +04:00
2013-11-18 23:52:37 +04:00
switch (data->dcb.fDtrControl) {
case DTR_CONTROL_DISABLE:
config->dtr = SP_DTR_OFF;
break;
case DTR_CONTROL_ENABLE:
config->dtr = SP_DTR_ON;
break;
case DTR_CONTROL_HANDSHAKE:
config->dtr = SP_DTR_FLOW_CONTROL;
break;
default:
config->dtr = -1;
2013-11-17 00:55:53 +04:00
}
2013-11-18 23:52:37 +04:00
config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
2013-11-18 23:55:43 +04:00
if (data->dcb.fInX) {
if (data->dcb.fOutX)
config->xon_xoff = SP_XONXOFF_INOUT;
else
config->xon_xoff = SP_XONXOFF_IN;
} else {
if (data->dcb.fOutX)
config->xon_xoff = SP_XONXOFF_OUT;
else
config->xon_xoff = SP_XONXOFF_DISABLED;
}
2013-11-18 23:52:37 +04:00
#else // !_WIN32
if (tcgetattr(port->fd, &data->term) < 0)
RETURN_FAIL("tcgetattr() failed");
2013-11-18 23:52:37 +04:00
if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
RETURN_FAIL("TIOCMGET ioctl failed");
#ifdef USE_TERMIOX
2013-11-22 23:00:24 +04:00
int ret = get_flow(port->fd, &data->flow);
if (ret == SP_ERR_FAIL && errno == EINVAL)
data->termiox_supported = 0;
else if (ret < 0)
RETURN_CODEVAL(ret);
2013-11-22 23:00:24 +04:00
else
data->termiox_supported = 1;
#else
data->termiox_supported = 0;
#endif
2013-11-17 00:55:53 +04:00
for (i = 0; i < NUM_STD_BAUDRATES; i++) {
2013-11-18 23:52:37 +04:00
if (cfgetispeed(&data->term) == std_baudrates[i].index) {
2013-11-17 00:55:53 +04:00
config->baudrate = std_baudrates[i].value;
break;
}
}
if (i == NUM_STD_BAUDRATES) {
#ifdef __APPLE__
config->baudrate = (int)data->term.c_ispeed;
2013-11-21 04:35:51 +04:00
#elif defined(__linux__)
TRY(get_baudrate(port->fd, &config->baudrate));
#else
2013-11-17 00:55:53 +04:00
config->baudrate = -1;
#endif
}
2013-11-17 00:55:53 +04:00
2013-11-18 23:52:37 +04:00
switch (data->term.c_cflag & CSIZE) {
2013-11-17 00:55:53 +04:00
case CS8:
config->bits = 8;
break;
case CS7:
config->bits = 7;
break;
case CS6:
config->bits = 6;
break;
case CS5:
config->bits = 5;
break;
default:
config->bits = -1;
}
2013-11-18 23:52:37 +04:00
if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
2013-11-17 00:55:53 +04:00
config->parity = SP_PARITY_NONE;
2013-11-18 23:52:37 +04:00
else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
2013-11-17 00:55:53 +04:00
config->parity = -1;
#ifdef CMSPAR
2013-11-25 22:05:58 +04:00
else if (data->term.c_cflag & CMSPAR)
config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
#endif
2013-11-17 00:55:53 +04:00
else
2013-11-18 23:52:37 +04:00
config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
2013-11-17 00:55:53 +04:00
2013-11-18 23:52:37 +04:00
config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
2013-11-17 00:55:53 +04:00
2013-11-18 23:52:37 +04:00
if (data->term.c_cflag & CRTSCTS) {
2013-11-17 00:55:53 +04:00
config->rts = SP_RTS_FLOW_CONTROL;
config->cts = SP_CTS_FLOW_CONTROL;
} else {
2013-11-22 23:00:24 +04:00
if (data->termiox_supported && data->flow & RTS_FLOW)
config->rts = SP_RTS_FLOW_CONTROL;
else
config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
2013-11-22 23:00:24 +04:00
config->cts = (data->termiox_supported && data->flow & CTS_FLOW) ?
SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
2013-11-17 00:55:53 +04:00
}
2013-11-22 23:00:24 +04:00
if (data->termiox_supported && data->flow & DTR_FLOW)
config->dtr = SP_DTR_FLOW_CONTROL;
else
config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
2013-11-22 23:00:24 +04:00
config->dsr = (data->termiox_supported && data->flow & DSR_FLOW) ?
SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
2013-11-20 00:46:52 +04:00
if (data->term.c_iflag & IXOFF) {
if (data->term.c_iflag & IXON)
config->xon_xoff = SP_XONXOFF_INOUT;
else
config->xon_xoff = SP_XONXOFF_IN;
} else {
if (data->term.c_iflag & IXON)
config->xon_xoff = SP_XONXOFF_OUT;
else
config->xon_xoff = SP_XONXOFF_DISABLED;
}
2013-11-17 00:55:53 +04:00
#endif
RETURN_OK();
2013-11-17 00:55:53 +04:00
}
2013-11-21 04:35:51 +04:00
static enum sp_return set_config(struct sp_port *port, struct port_data *data,
const struct sp_port_config *config)
{
2013-11-18 23:52:37 +04:00
unsigned int i;
#ifdef __APPLE__
BAUD_TYPE baud_nonstd;
baud_nonstd = B0;
#endif
2013-11-21 04:35:51 +04:00
#ifdef __linux__
int baud_nonstd = 0;
#endif
TRACE("%p, %p, %p", port, data, config);
2013-11-23 05:08:57 +04:00
DEBUG("Setting configuration for port %s", port->name);
2013-11-18 23:52:37 +04:00
#ifdef _WIN32
if (config->baudrate >= 0) {
2013-11-18 23:52:37 +04:00
for (i = 0; i < NUM_STD_BAUDRATES; i++) {
if (config->baudrate == std_baudrates[i].value) {
data->dcb.BaudRate = std_baudrates[i].index;
break;
}
}
2013-11-18 23:52:37 +04:00
if (i == NUM_STD_BAUDRATES)
data->dcb.BaudRate = config->baudrate;
}
2013-11-18 23:52:37 +04:00
if (config->bits >= 0)
data->dcb.ByteSize = config->bits;
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;
2013-11-25 22:05:58 +04:00
case SP_PARITY_ODD:
data->dcb.Parity = ODDPARITY;
break;
2013-11-18 23:52:37 +04:00
case SP_PARITY_EVEN:
data->dcb.Parity = EVENPARITY;
break;
2013-11-25 22:05:58 +04:00
case SP_PARITY_MARK:
data->dcb.Parity = MARKPARITY;
break;
case SP_PARITY_SPACE:
data->dcb.Parity = SPACEPARITY;
2013-11-18 23:52:37 +04:00
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
2013-11-18 23:52:37 +04:00
}
}
2013-11-18 23:52:37 +04:00
if (config->stopbits >= 0) {
switch (config->stopbits) {
/* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
case 1:
data->dcb.StopBits = ONESTOPBIT;
break;
case 2:
data->dcb.StopBits = TWOSTOPBITS;
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
2013-11-18 23:52:37 +04:00
}
}
if (config->rts >= 0) {
switch (config->rts) {
case SP_RTS_OFF:
data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
break;
case SP_RTS_ON:
data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
break;
case SP_RTS_FLOW_CONTROL:
data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
2013-11-18 23:52:37 +04:00
}
}
if (config->cts >= 0) {
switch (config->cts) {
case SP_CTS_IGNORE:
data->dcb.fOutxCtsFlow = FALSE;
break;
case SP_CTS_FLOW_CONTROL:
data->dcb.fOutxCtsFlow = TRUE;
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
2013-11-18 23:52:37 +04:00
}
}
if (config->dtr >= 0) {
switch (config->dtr) {
case SP_DTR_OFF:
data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
break;
case SP_DTR_ON:
data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
break;
case SP_DTR_FLOW_CONTROL:
data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
2013-11-18 23:52:37 +04:00
}
}
if (config->dsr >= 0) {
switch (config->dsr) {
case SP_DSR_IGNORE:
data->dcb.fOutxDsrFlow = FALSE;
break;
case SP_DSR_FLOW_CONTROL:
data->dcb.fOutxDsrFlow = TRUE;
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
2013-11-18 23:52:37 +04:00
}
}
2013-11-18 23:52:37 +04:00
if (config->xon_xoff >= 0) {
switch (config->xon_xoff) {
case SP_XONXOFF_DISABLED:
data->dcb.fInX = FALSE;
data->dcb.fOutX = FALSE;
break;
case SP_XONXOFF_IN:
data->dcb.fInX = TRUE;
data->dcb.fOutX = FALSE;
break;
case SP_XONXOFF_OUT:
data->dcb.fInX = FALSE;
data->dcb.fOutX = TRUE;
break;
case SP_XONXOFF_INOUT:
data->dcb.fInX = TRUE;
data->dcb.fOutX = TRUE;
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2013-11-18 23:52:37 +04:00
}
}
if (!SetCommState(port->hdl, &data->dcb))
RETURN_FAIL("SetCommState() failed");
2013-11-18 23:52:37 +04:00
#else /* !_WIN32 */
2013-11-18 23:52:37 +04:00
2013-11-21 04:35:51 +04:00
int controlbits;
if (config->baudrate >= 0) {
2013-11-18 23:52:37 +04:00
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_FAIL("cfsetospeed() failed");
2013-11-18 23:52:37 +04:00
if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
RETURN_FAIL("cfsetispeed() failed");
2013-11-18 23:52:37 +04:00
break;
}
}
/* Non-standard baud rate */
if (i == NUM_STD_BAUDRATES) {
#ifdef __APPLE__
2013-11-22 18:53:34 +04:00
/* Set "dummy" baud rate. */
if (cfsetspeed(&data->term, B9600) < 0)
RETURN_FAIL("cfsetspeed() failed");
baud_nonstd = config->baudrate;
2013-11-21 04:35:51 +04:00
#elif defined(__linux__)
baud_nonstd = 1;
#else
RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
#endif
}
2013-11-18 23:52:37 +04:00
}
if (config->bits >= 0) {
data->term.c_cflag &= ~CSIZE;
switch (config->bits) {
case 8:
data->term.c_cflag |= CS8;
break;
case 7:
data->term.c_cflag |= CS7;
break;
case 6:
data->term.c_cflag |= CS6;
break;
case 5:
data->term.c_cflag |= CS5;
break;
2013-11-18 23:52:37 +04:00
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
2013-11-18 23:52:37 +04:00
}
}
if (config->parity >= 0) {
data->term.c_iflag &= ~IGNPAR;
data->term.c_cflag &= ~(PARENB | PARODD);
#ifdef CMSPAR
data->term.c_cflag &= ~CMSPAR;
#endif
2013-11-18 23:52:37 +04:00
switch (config->parity) {
case SP_PARITY_NONE:
data->term.c_iflag |= IGNPAR;
break;
case SP_PARITY_EVEN:
data->term.c_cflag |= PARENB;
break;
case SP_PARITY_ODD:
data->term.c_cflag |= PARENB | PARODD;
break;
#ifdef CMSPAR
2013-11-25 22:05:58 +04:00
case SP_PARITY_MARK:
data->term.c_cflag |= PARENB | PARODD;
data->term.c_cflag |= CMSPAR;
2013-11-25 22:05:58 +04:00
break;
case SP_PARITY_SPACE:
data->term.c_cflag |= PARENB;
data->term.c_cflag |= CMSPAR;
2013-11-25 22:05:58 +04:00
break;
#else
case SP_PARITY_MARK:
case SP_PARITY_SPACE:
RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
#endif
2013-11-18 23:52:37 +04:00
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
2013-11-18 23:52:37 +04:00
}
}
if (config->stopbits >= 0) {
data->term.c_cflag &= ~CSTOPB;
switch (config->stopbits) {
case 1:
data->term.c_cflag &= ~CSTOPB;
break;
case 2:
data->term.c_cflag |= CSTOPB;
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
2013-11-18 23:52:37 +04:00
}
}
if (config->rts >= 0 || config->cts >= 0) {
2013-11-22 23:00:24 +04:00
if (data->termiox_supported) {
data->flow &= ~(RTS_FLOW | CTS_FLOW);
switch (config->rts) {
case SP_RTS_OFF:
case SP_RTS_ON:
controlbits = TIOCM_RTS;
if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
RETURN_FAIL("Setting RTS signal level failed");
2013-11-22 23:00:24 +04:00
break;
case SP_RTS_FLOW_CONTROL:
data->flow |= RTS_FLOW;
break;
default:
break;
2013-11-18 23:52:37 +04:00
}
2013-11-22 23:00:24 +04:00
if (config->cts == SP_CTS_FLOW_CONTROL)
data->flow |= CTS_FLOW;
2013-11-18 23:52:37 +04:00
2013-11-22 23:00:24 +04:00
if (data->flow & (RTS_FLOW | CTS_FLOW))
2013-11-18 23:52:37 +04:00
data->term.c_iflag |= CRTSCTS;
2013-11-22 23:00:24 +04:00
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");
2013-11-22 23:00:24 +04:00
}
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");
2013-11-22 23:00:24 +04:00
}
2013-11-18 23:52:37 +04:00
} else {
2013-11-22 23:00:24 +04:00
/* 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");
2013-11-22 23:00:24 +04:00
}
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");
2013-11-22 23:00:24 +04:00
}
2013-11-18 23:52:37 +04:00
}
}
}
if (config->dtr >= 0 || config->dsr >= 0) {
2013-11-22 23:00:24 +04:00
if (data->termiox_supported) {
data->flow &= ~(DTR_FLOW | DSR_FLOW);
switch (config->dtr) {
case SP_DTR_OFF:
case SP_DTR_ON:
controlbits = TIOCM_DTR;
if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
RETURN_FAIL("Setting DTR signal level failed");
2013-11-22 23:00:24 +04:00
break;
case SP_DTR_FLOW_CONTROL:
data->flow |= DTR_FLOW;
break;
default:
break;
}
if (config->dsr == SP_DSR_FLOW_CONTROL)
data->flow |= DSR_FLOW;
} else {
/* DTR/DSR flow control not supported. */
if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
2013-11-18 23:52:37 +04:00
2013-11-22 23:00:24 +04:00
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");
2013-11-22 23:00:24 +04:00
}
2013-11-18 23:52:37 +04:00
}
}
if (config->xon_xoff >= 0) {
data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
switch (config->xon_xoff) {
case SP_XONXOFF_DISABLED:
break;
case SP_XONXOFF_IN:
data->term.c_iflag |= IXOFF;
break;
case SP_XONXOFF_OUT:
data->term.c_iflag |= IXON | IXANY;
break;
case SP_XONXOFF_INOUT:
data->term.c_iflag |= IXON | IXOFF | IXANY;
break;
default:
RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2013-11-18 23:52:37 +04:00
}
}
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_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_FAIL("cfsetspeed() failed");
}
2013-11-21 04:35:51 +04:00
#elif defined(__linux__)
if (baud_nonstd)
TRY(set_baudrate(port->fd, config->baudrate));
#ifdef USE_TERMIOX
2013-11-22 23:00:24 +04:00
if (data->termiox_supported)
TRY(set_flow(port->fd, data->flow));
#endif
2013-11-21 04:35:51 +04:00
#endif
#endif /* !_WIN32 */
2013-11-18 23:52:37 +04:00
RETURN_OK();
2013-11-18 23:52:37 +04:00
}
2013-11-24 00:41:01 +04:00
enum sp_return sp_new_config(struct sp_port_config **config_ptr)
{
struct sp_port_config *config;
2013-11-24 00:41:01 +04:00
2013-11-26 19:12:20 +04:00
TRACE("%p", config_ptr);
2013-11-24 00:41:01 +04:00
if (!config_ptr)
RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
*config_ptr = NULL;
if (!(config = malloc(sizeof(struct sp_port_config))))
2013-11-24 00:41:01 +04:00
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;
2013-11-24 00:41:01 +04:00
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)
2013-11-24 00:41:01 +04:00
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)
2013-11-18 23:52:37 +04:00
{
struct port_data data;
2013-11-18 23:52:37 +04:00
struct sp_port_config prev_config;
TRACE("%p, %p", port, config);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
if (!config)
RETURN_ERROR(SP_ERR_ARG, "Null config");
2013-11-18 23:52:37 +04:00
TRY(get_config(port, &data, &prev_config));
TRY(set_config(port, &data, config));
RETURN_OK();
}
2013-11-24 00:41:01 +04:00
#define CREATE_ACCESSORS(x, type) \
enum sp_return sp_set_##x(struct sp_port *port, type x) { \
struct port_data data; \
2013-11-18 23:52:37 +04:00
struct sp_port_config config; \
TRACE("%p, %d", port, x); \
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT(); \
2013-11-18 23:52:37 +04:00
TRY(get_config(port, &data, &config)); \
config.x = x; \
TRY(set_config(port, &data, &config)); \
RETURN_OK(); \
2013-11-24 00:41:01 +04:00
} \
enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \
2013-11-26 19:12:20 +04:00
TRACE("%p, %p", config, x); \
2013-11-24 00:41:01 +04:00
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(); \
}
2013-11-24 00:41:01 +04:00
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)
2013-11-18 23:52:37 +04:00
{
2013-11-24 00:41:01 +04:00
if (!config)
RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2013-11-23 15:39:59 +04:00
if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2013-11-18 23:52:37 +04:00
if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2013-11-24 00:41:01 +04:00
config->xon_xoff = SP_XONXOFF_INOUT;
2013-11-18 23:52:37 +04:00
else
2013-11-24 00:41:01 +04:00
config->xon_xoff = SP_XONXOFF_DISABLED;
2013-11-18 23:52:37 +04:00
if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2013-11-24 00:41:01 +04:00
config->rts = SP_RTS_FLOW_CONTROL;
config->cts = SP_CTS_FLOW_CONTROL;
2013-11-18 23:52:37 +04:00
} else {
2013-11-24 00:41:01 +04:00
if (config->rts == SP_RTS_FLOW_CONTROL)
config->rts = SP_RTS_ON;
config->cts = SP_CTS_IGNORE;
2013-11-18 23:52:37 +04:00
}
if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2013-11-24 00:41:01 +04:00
config->dtr = SP_DTR_FLOW_CONTROL;
config->dsr = SP_DSR_FLOW_CONTROL;
2013-11-18 23:52:37 +04:00
} else {
2013-11-24 00:41:01 +04:00
if (config->dtr == SP_DTR_FLOW_CONTROL)
config->dtr = SP_DTR_ON;
config->dsr = SP_DSR_IGNORE;
2013-11-18 23:52:37 +04:00
}
2013-11-24 00:41:01 +04:00
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));
2013-11-18 23:52:37 +04:00
TRY(set_config(port, &data, &config));
RETURN_OK();
2013-11-18 23:52:37 +04:00
}
2013-11-20 22:56:35 +04:00
enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals)
{
TRACE("%p, %p", port, signals);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
2013-11-20 22:56:35 +04:00
if (!signals)
RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2013-11-20 22:56:35 +04:00
2013-11-23 05:08:57 +04:00
DEBUG("Getting control signals for port %s", port->name);
2013-11-20 22:56:35 +04:00
*signals = 0;
#ifdef _WIN32
DWORD bits;
if (GetCommModemStatus(port->hdl, &bits) == 0)
RETURN_FAIL("GetCommModemStatus() failed");
2013-11-20 22:56:35 +04:00
if (bits & MS_CTS_ON)
*signals |= SP_SIG_CTS;
if (bits & MS_DSR_ON)
*signals |= SP_SIG_DSR;
if (bits & MS_RLSD_ON)
*signals |= SP_SIG_DCD;
if (bits & MS_RING_ON)
2013-11-20 22:56:35 +04:00
*signals |= SP_SIG_RI;
#else
int bits;
if (ioctl(port->fd, TIOCMGET, &bits) < 0)
RETURN_FAIL("TIOCMGET ioctl failed");
2013-11-20 22:56:35 +04:00
if (bits & TIOCM_CTS)
*signals |= SP_SIG_CTS;
if (bits & TIOCM_DSR)
*signals |= SP_SIG_DSR;
if (bits & TIOCM_CAR)
*signals |= SP_SIG_DCD;
if (bits & TIOCM_RNG)
*signals |= SP_SIG_RI;
#endif
RETURN_OK();
2013-11-20 22:56:35 +04:00
}
enum sp_return sp_start_break(struct sp_port *port)
{
TRACE("%p", port);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
#ifdef _WIN32
if (SetCommBreak(port->hdl) == 0)
RETURN_FAIL("SetCommBreak() failed");
#else
if (ioctl(port->fd, TIOCSBRK, 1) < 0)
RETURN_FAIL("TIOCSBRK ioctl failed");
#endif
RETURN_OK();
}
enum sp_return sp_end_break(struct sp_port *port)
{
TRACE("%p", port);
2013-11-23 15:39:59 +04:00
CHECK_OPEN_PORT();
#ifdef _WIN32
if (ClearCommBreak(port->hdl) == 0)
RETURN_FAIL("ClearCommBreak() failed");
#else
if (ioctl(port->fd, TIOCCBRK, 1) < 0)
RETURN_FAIL("TIOCCBRK ioctl failed");
#endif
RETURN_OK();
}
int sp_last_error_code(void)
{
TRACE("");
#ifdef _WIN32
RETURN_VALUE("%d", GetLastError());
#else
RETURN_VALUE("%d", errno);
#endif
}
char *sp_last_error_message(void)
{
TRACE("");
#ifdef _WIN32
LPVOID message;
DWORD error = GetLastError();
FormatMessage(
FORMAT_MESSAGE_ALLOCATE_BUFFER |
FORMAT_MESSAGE_FROM_SYSTEM |
FORMAT_MESSAGE_IGNORE_INSERTS,
NULL,
error,
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
(LPTSTR) &message,
0, NULL );
RETURN_VALUE("%s", message);
#else
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);
}