2 * This file is part of the libserialport project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
6 * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
7 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include <sys/types.h>
39 #include <sys/ioctl.h>
44 #include <IOKit/IOKitLib.h>
45 #include <IOKit/serial/IOSerialKeys.h>
46 #include <IOKit/serial/ioss.h>
47 #include <sys/syslimits.h>
54 #include "linux/serial.h"
56 #include "linux_termios.h"
58 /* TCGETX/TCSETX is not available everywhere. */
59 #if defined(TCGETX) && defined(TCSETX) && defined(HAVE_TERMIOX)
64 /* TIOCINQ/TIOCOUTQ is not available everywhere. */
65 #if !defined(TIOCINQ) && defined(FIONREAD)
66 #define TIOCINQ FIONREAD
68 #if !defined(TIOCOUTQ) && defined(FIONWRITE)
69 #define TIOCOUTQ FIONWRITE
73 #include "linux_termios.h"
76 #include "libserialport.h"
82 COMMTIMEOUTS timeouts;
92 struct sp_port_config {
95 enum sp_parity parity;
101 enum sp_xonxoff xon_xoff;
110 int termiox_supported;
115 /* Standard baud rates. */
117 #define BAUD_TYPE DWORD
118 #define BAUD(n) {CBR_##n, n}
120 #define BAUD_TYPE speed_t
121 #define BAUD(n) {B##n, n}
124 struct std_baudrate {
129 const struct std_baudrate std_baudrates[] = {
132 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
133 * have documented CBR_* macros.
135 BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
136 BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
137 BAUD(115200), BAUD(128000), BAUD(256000),
139 BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
140 BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
141 BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
143 #if !defined(__APPLE__) && !defined(__OpenBSD__)
149 void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
151 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
152 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
154 /* Debug output macros. */
155 #define DEBUG(fmt, ...) do { if (sp_debug_handler) sp_debug_handler(fmt ".\n", ##__VA_ARGS__); } while (0)
156 #define DEBUG_ERROR(err, msg) DEBUG("%s returning " #err ": " msg, __func__)
157 #define DEBUG_FAIL(msg) do { \
158 char *errmsg = sp_last_error_message(); \
159 DEBUG("%s returning SP_ERR_FAIL: " msg ": %s", __func__, errmsg); \
160 sp_free_error_message(errmsg); \
162 #define RETURN() do { DEBUG("%s returning", __func__); return; } while(0)
163 #define RETURN_CODE(x) do { DEBUG("%s returning " #x, __func__); return x; } while (0)
164 #define RETURN_CODEVAL(x) do { \
166 case SP_OK: RETURN_CODE(SP_OK); \
167 case SP_ERR_ARG: RETURN_CODE(SP_ERR_ARG); \
168 case SP_ERR_FAIL: RETURN_CODE(SP_ERR_FAIL); \
169 case SP_ERR_MEM: RETURN_CODE(SP_ERR_MEM); \
170 case SP_ERR_SUPP: RETURN_CODE(SP_ERR_SUPP); \
173 #define RETURN_OK() RETURN_CODE(SP_OK);
174 #define RETURN_ERROR(err, msg) do { DEBUG_ERROR(err, msg); return err; } while (0)
175 #define RETURN_FAIL(msg) do { DEBUG_FAIL(msg); return SP_ERR_FAIL; } while (0)
176 #define RETURN_VALUE(fmt, x) do { \
178 DEBUG("%s returning " fmt, __func__, _x); \
181 #define SET_ERROR(val, err, msg) do { DEBUG_ERROR(err, msg); val = err; } while (0)
182 #define SET_FAIL(val, msg) do { DEBUG_FAIL(msg); val = SP_ERR_FAIL; } while (0)
183 #define TRACE(fmt, ...) DEBUG("%s(" fmt ") called", __func__, ##__VA_ARGS__)
185 #define TRY(x) do { int ret = x; if (ret != SP_OK) RETURN_CODEVAL(ret); } while (0)
187 /* Helper functions. */
188 static struct sp_port **list_append(struct sp_port **list, const char *portname);
189 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
190 struct sp_port_config *config);
191 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
192 const struct sp_port_config *config);
194 enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
196 struct sp_port *port;
199 TRACE("%s, %p", portname, port_ptr);
202 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
207 RETURN_ERROR(SP_ERR_ARG, "Null port name");
209 DEBUG("Building structure for port %s", portname);
211 if (!(port = malloc(sizeof(struct sp_port))))
212 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
214 len = strlen(portname) + 1;
216 if (!(port->name = malloc(len))) {
218 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
221 memcpy(port->name, portname, len);
224 port->hdl = INVALID_HANDLE_VALUE;
234 char *sp_get_port_name(const struct sp_port *port)
241 RETURN_VALUE("%s", port->name);
244 enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr)
246 TRACE("%p, %p", port, result_ptr);
249 RETURN_ERROR(SP_ERR_ARG, "Null port");
252 HANDLE *handle_ptr = result_ptr;
253 *handle_ptr = port->hdl;
255 int *fd_ptr = result_ptr;
262 enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
264 TRACE("%p, %p", port, copy_ptr);
267 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
272 RETURN_ERROR(SP_ERR_ARG, "Null port");
275 RETURN_ERROR(SP_ERR_ARG, "Null port name");
277 DEBUG("Copying port structure");
279 RETURN_VALUE("%p", sp_get_port_by_name(port->name, copy_ptr));
282 void sp_free_port(struct sp_port *port)
291 DEBUG("Freeing port structure");
301 static struct sp_port **list_append(struct sp_port **list, const char *portname)
306 for (count = 0; list[count]; count++);
307 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
310 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
312 list[count + 1] = NULL;
316 sp_free_port_list(list);
320 enum sp_return sp_list_ports(struct sp_port ***list_ptr)
322 struct sp_port **list;
323 int ret = SP_ERR_SUPP;
325 TRACE("%p", list_ptr);
328 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
330 DEBUG("Enumerating ports");
332 if (!(list = malloc(sizeof(struct sp_port **))))
333 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
340 DWORD max_value_len, max_data_size, max_data_len;
341 DWORD value_len, data_size, data_len;
342 DWORD type, index = 0;
348 DEBUG("Opening registry key");
349 if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
350 0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) {
351 SET_FAIL(ret, "RegOpenKeyEx() failed");
354 DEBUG("Querying registry key value and data sizes");
355 if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
356 &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) {
357 SET_FAIL(ret, "RegQueryInfoKey() failed");
360 max_data_len = max_data_size / sizeof(TCHAR);
361 if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) {
362 SET_ERROR(ret, SP_ERR_MEM, "registry value malloc failed");
365 if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) {
366 SET_ERROR(ret, SP_ERR_MEM, "registry data malloc failed");
369 DEBUG("Iterating over values");
371 value_len = max_value_len + 1,
372 data_size = max_data_size,
373 RegEnumValue(key, index, value, &value_len,
374 NULL, &type, (LPBYTE)data, &data_size) == ERROR_SUCCESS)
376 data_len = data_size / sizeof(TCHAR);
377 data[data_len] = '\0';
379 name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
381 name_len = data_len + 1;
383 if (!(name = malloc(name_len))) {
384 SET_ERROR(ret, SP_ERR_MEM, "registry port name malloc failed");
388 WideCharToMultiByte(CP_ACP, 0, data, -1, name, name_len, NULL, NULL);
392 if (type == REG_SZ) {
393 DEBUG("Found port %s", name);
394 if (!(list = list_append(list, name))) {
395 SET_ERROR(ret, SP_ERR_MEM, "list append failed");
411 CFMutableDictionaryRef classes;
420 DEBUG("Getting IOKit master port");
421 if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) {
422 SET_FAIL(ret, "IOMasterPort() failed");
426 DEBUG("Creating matching dictionary");
427 if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) {
428 SET_FAIL(ret, "IOServiceMatching() failed");
432 CFDictionarySetValue(classes,
433 CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
435 DEBUG("Getting matching services");
436 if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS) {
437 SET_FAIL(ret, "IOServiceGetMatchingServices() failed");
441 if (!(path = malloc(PATH_MAX))) {
442 SET_ERROR(ret, SP_ERR_MEM, "device path malloc failed");
446 DEBUG("Iterating over results");
447 while ((port = IOIteratorNext(iter))) {
448 cf_path = IORegistryEntryCreateCFProperty(port,
449 CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
451 result = CFStringGetCString(cf_path,
452 path, PATH_MAX, kCFStringEncodingASCII);
455 DEBUG("Found port %s", path);
456 if (!(list = list_append(list, path))) {
457 SET_ERROR(ret, SP_ERR_MEM, "list append failed");
458 IOObjectRelease(port);
463 IOObjectRelease(port);
468 IOObjectRelease(iter);
471 #if defined(__linux__) && defined(HAVE_LIBUDEV)
473 struct udev_enumerate *ud_enumerate;
474 struct udev_list_entry *ud_list;
475 struct udev_list_entry *ud_entry;
477 struct udev_device *ud_dev, *ud_parent;
480 int fd, ioctl_result;
481 struct serial_struct serial_info;
485 DEBUG("Enumerating tty devices");
487 ud_enumerate = udev_enumerate_new(ud);
488 udev_enumerate_add_match_subsystem(ud_enumerate, "tty");
489 udev_enumerate_scan_devices(ud_enumerate);
490 ud_list = udev_enumerate_get_list_entry(ud_enumerate);
491 DEBUG("Iterating over results");
492 udev_list_entry_foreach(ud_entry, ud_list) {
493 path = udev_list_entry_get_name(ud_entry);
494 DEBUG("Found device %s", path);
495 ud_dev = udev_device_new_from_syspath(ud, path);
496 /* If there is no parent device, this is a virtual tty. */
497 ud_parent = udev_device_get_parent(ud_dev);
498 if (ud_parent == NULL) {
499 DEBUG("No parent device, assuming virtual tty");
500 udev_device_unref(ud_dev);
503 name = udev_device_get_devnode(ud_dev);
504 /* The serial8250 driver has a hardcoded number of ports.
505 * The only way to tell which actually exist on a given system
506 * is to try to open them and make an ioctl call. */
507 driver = udev_device_get_driver(ud_parent);
508 if (driver && !strcmp(driver, "serial8250")) {
509 DEBUG("serial8250 device, attempting to open");
510 if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0) {
511 DEBUG("open failed, skipping");
514 ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
516 if (ioctl_result != 0) {
517 DEBUG("ioctl failed, skipping");
520 if (serial_info.type == PORT_UNKNOWN) {
521 DEBUG("port type is unknown, skipping");
525 DEBUG("Found port %s", name);
526 list = list_append(list, name);
528 udev_device_unref(ud_dev);
530 SET_ERROR(ret, SP_ERR_MEM, "list append failed");
535 udev_enumerate_unref(ud_enumerate);
544 DEBUG_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform.");
547 sp_free_port_list(list);
553 void sp_free_port_list(struct sp_port **list)
564 DEBUG("Freeing port list");
566 for (i = 0; list[i]; i++)
567 sp_free_port(list[i]);
573 #define CHECK_PORT() do { \
575 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
576 if (port->name == NULL) \
577 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
580 #define CHECK_PORT_HANDLE() do { \
581 if (port->hdl == INVALID_HANDLE_VALUE) \
582 RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
585 #define CHECK_PORT_HANDLE() do { \
587 RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
590 #define CHECK_OPEN_PORT() do { \
592 CHECK_PORT_HANDLE(); \
595 enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
597 struct port_data data;
598 struct sp_port_config config;
601 TRACE("%p, 0x%x", port, flags);
605 if (flags > (SP_MODE_READ | SP_MODE_WRITE))
606 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
608 DEBUG("Opening port %s", port->name);
611 DWORD desired_access = 0, flags_and_attributes = 0;
612 char *escaped_port_name;
614 /* Prefix port name with '\\.\' to work with ports above COM9. */
615 if (!(escaped_port_name = malloc(strlen(port->name + 5))))
616 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
617 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
619 /* Map 'flags' to the OS-specific settings. */
620 flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
621 if (flags & SP_MODE_READ)
622 desired_access |= GENERIC_READ;
623 if (flags & SP_MODE_WRITE)
624 desired_access |= GENERIC_WRITE;
626 port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
627 OPEN_EXISTING, flags_and_attributes, 0);
629 free(escaped_port_name);
631 if (port->hdl == INVALID_HANDLE_VALUE)
632 RETURN_FAIL("port CreateFile() failed");
634 /* All timeouts initially disabled. */
635 port->timeouts.ReadIntervalTimeout = 0;
636 port->timeouts.ReadTotalTimeoutMultiplier = 0;
637 port->timeouts.ReadTotalTimeoutConstant = 0;
638 port->timeouts.WriteTotalTimeoutMultiplier = 0;
639 port->timeouts.WriteTotalTimeoutConstant = 0;
641 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
643 RETURN_FAIL("SetCommTimeouts() failed");
646 /* Prepare OVERLAPPED structures. */
647 memset(&port->read_ovl, 0, sizeof(port->read_ovl));
648 memset(&port->write_ovl, 0, sizeof(port->write_ovl));
649 port->read_ovl.hEvent = INVALID_HANDLE_VALUE;
650 port->write_ovl.hEvent = INVALID_HANDLE_VALUE;
651 if ((port->read_ovl.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL)) == INVALID_HANDLE_VALUE) {
653 RETURN_FAIL("read event CreateEvent() failed");
655 if ((port->write_ovl.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL)) == INVALID_HANDLE_VALUE) {
657 RETURN_FAIL("write event CreateEvent() failed");
660 port->writing = FALSE;
663 int flags_local = O_NONBLOCK | O_NOCTTY;
665 /* Map 'flags' to the OS-specific settings. */
666 if (flags & (SP_MODE_READ | SP_MODE_WRITE))
667 flags_local |= O_RDWR;
668 else if (flags & SP_MODE_READ)
669 flags_local |= O_RDONLY;
670 else if (flags & SP_MODE_WRITE)
671 flags_local |= O_WRONLY;
673 if ((port->fd = open(port->name, flags_local)) < 0)
674 RETURN_FAIL("open() failed");
677 ret = get_config(port, &data, &config);
684 /* Set sane port settings. */
686 data.dcb.fBinary = TRUE;
687 data.dcb.fDsrSensitivity = FALSE;
688 data.dcb.fErrorChar = FALSE;
689 data.dcb.fNull = FALSE;
690 data.dcb.fAbortOnError = TRUE;
692 /* Turn off all fancy termios tricks, give us a raw channel. */
693 data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
695 data.term.c_iflag &= ~IUCLC;
697 data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET);
699 data.term.c_oflag &= ~OLCUC;
702 data.term.c_oflag &= ~NLDLY;
705 data.term.c_oflag &= ~CRDLY;
708 data.term.c_oflag &= ~TABDLY;
711 data.term.c_oflag &= ~BSDLY;
714 data.term.c_oflag &= ~VTDLY;
717 data.term.c_oflag &= ~FFDLY;
720 data.term.c_oflag &= ~OFILL;
722 data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
723 data.term.c_cc[VMIN] = 0;
724 data.term.c_cc[VTIME] = 0;
726 /* Ignore modem status lines; enable receiver; leave control lines alone on close. */
727 data.term.c_cflag |= (CLOCAL | CREAD | HUPCL);
730 ret = set_config(port, &data, &config);
740 enum sp_return sp_close(struct sp_port *port)
746 DEBUG("Closing port %s", port->name);
749 /* Returns non-zero upon success, 0 upon failure. */
750 if (CloseHandle(port->hdl) == 0)
751 RETURN_FAIL("port CloseHandle() failed");
752 port->hdl = INVALID_HANDLE_VALUE;
753 /* Close event handle created for overlapped reads. */
754 if (port->read_ovl.hEvent != INVALID_HANDLE_VALUE && CloseHandle(port->read_ovl.hEvent) == 0)
755 RETURN_FAIL("read event CloseHandle() failed");
756 /* Close event handle created for overlapped writes. */
757 if (port->write_ovl.hEvent != INVALID_HANDLE_VALUE && CloseHandle(port->write_ovl.hEvent) == 0)
758 RETURN_FAIL("write event CloseHandle() failed");
760 /* Returns 0 upon success, -1 upon failure. */
761 if (close(port->fd) == -1)
762 RETURN_FAIL("close() failed");
769 enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
771 TRACE("%p, 0x%x", port, buffers);
775 if (buffers > SP_BUF_BOTH)
776 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
778 const char *buffer_names[] = {"no", "input", "output", "both"};
780 DEBUG("Flushing %s buffers on port %s", buffer_names[buffers], port->name);
784 if (buffers & SP_BUF_INPUT)
785 flags |= PURGE_RXCLEAR;
786 if (buffers & SP_BUF_OUTPUT)
787 flags |= PURGE_TXCLEAR;
789 /* Returns non-zero upon success, 0 upon failure. */
790 if (PurgeComm(port->hdl, flags) == 0)
791 RETURN_FAIL("PurgeComm() failed");
794 if (buffers & SP_BUF_BOTH)
796 else if (buffers & SP_BUF_INPUT)
798 else if (buffers & SP_BUF_OUTPUT)
801 /* Returns 0 upon success, -1 upon failure. */
802 if (tcflush(port->fd, flags) < 0)
803 RETURN_FAIL("tcflush() failed");
808 enum sp_return sp_drain(struct sp_port *port)
814 DEBUG("Draining port %s", port->name);
817 /* Returns non-zero upon success, 0 upon failure. */
818 if (FlushFileBuffers(port->hdl) == 0)
819 RETURN_FAIL("FlushFileBuffers() failed");
826 result = ioctl(port->fd, TCSBRK, &arg);
828 result = tcdrain(port->fd);
831 if (errno == EINTR) {
832 DEBUG("tcdrain() was interrupted");
835 RETURN_FAIL("tcdrain() failed");
844 enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout)
846 TRACE("%p, %p, %d, %d", port, buf, count, timeout);
851 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
854 DEBUG("Writing %d bytes to port %s, timeout %d ms", count, port->name, timeout);
856 DEBUG("Writing %d bytes to port %s, no timeout", count, port->name);
859 RETURN_VALUE("0", 0);
862 DWORD bytes_written = 0;
865 /* Wait for previous non-blocking write to complete, if any. */
867 DEBUG("Waiting for previous write to complete");
868 result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
871 RETURN_FAIL("Previous write failed to complete");
872 DEBUG("Previous write completed");
876 port->timeouts.WriteTotalTimeoutConstant = timeout;
877 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
878 RETURN_FAIL("SetCommTimeouts() failed");
881 if (WriteFile(port->hdl, buf, count, NULL, &port->write_ovl) == 0) {
882 if (GetLastError() == ERROR_IO_PENDING) {
883 DEBUG("Waiting for write to complete");
884 GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
885 DEBUG("Write completed, %d/%d bytes written", bytes_written, count);
886 RETURN_VALUE("%d", bytes_written);
888 RETURN_FAIL("WriteFile() failed");
891 DEBUG("Write completed immediately");
892 RETURN_VALUE("%d", count);
895 size_t bytes_written = 0;
896 unsigned char *ptr = (unsigned char *) buf;
897 struct timeval start, delta, now, end = {0, 0};
902 /* Get time at start of operation. */
903 gettimeofday(&start, NULL);
904 /* Define duration of timeout. */
905 delta.tv_sec = timeout / 1000;
906 delta.tv_usec = (timeout % 1000) * 1000;
907 /* Calculate time at which we should give up. */
908 timeradd(&start, &delta, &end);
911 /* Loop until we have written the requested number of bytes. */
912 while (bytes_written < count)
914 /* Wait until space is available. */
916 FD_SET(port->fd, &fds);
918 gettimeofday(&now, NULL);
919 if (timercmp(&now, &end, >)) {
920 DEBUG("write timed out");
921 RETURN_VALUE("%d", bytes_written);
923 timersub(&end, &now, &delta);
925 result = select(port->fd + 1, NULL, &fds, NULL, timeout ? &delta : NULL);
927 if (errno == EINTR) {
928 DEBUG("select() call was interrupted, repeating");
931 RETURN_FAIL("select() failed");
933 } else if (result == 0) {
934 DEBUG("write timed out");
935 RETURN_VALUE("%d", bytes_written);
939 result = write(port->fd, ptr, count - bytes_written);
943 /* This shouldn't happen because we did a select() first, but handle anyway. */
946 /* This is an actual failure. */
947 RETURN_FAIL("write() failed");
950 bytes_written += result;
954 RETURN_VALUE("%d", bytes_written);
958 enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_t count)
960 TRACE("%p, %p, %d", port, buf, count);
965 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
967 DEBUG("Writing up to %d bytes to port %s", count, port->name);
970 RETURN_VALUE("0", 0);
974 BYTE *ptr = (BYTE *) buf;
976 /* Check whether previous write is complete. */
978 if (HasOverlappedIoCompleted(&port->write_ovl)) {
979 DEBUG("Previous write completed");
982 DEBUG("Previous write not complete");
983 /* Can't take a new write until the previous one finishes. */
984 RETURN_VALUE("0", 0);
989 port->timeouts.WriteTotalTimeoutConstant = 0;
990 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
991 RETURN_FAIL("SetCommTimeouts() failed");
993 /* Keep writing data until the OS has to actually start an async IO for it.
994 * At that point we know the buffer is full. */
995 while (written < count)
997 /* Copy first byte of user buffer. */
998 port->pending_byte = *ptr++;
1000 /* Start asynchronous write. */
1001 if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) {
1002 if (GetLastError() == ERROR_IO_PENDING) {
1003 DEBUG("Asynchronous write started");
1005 RETURN_VALUE("%d", ++written);
1007 /* Actual failure of some kind. */
1008 RETURN_FAIL("WriteFile() failed");
1011 DEBUG("Single byte written immediately.");
1016 DEBUG("All bytes written immediately.");
1018 RETURN_VALUE("%d", written);
1020 /* Returns the number of bytes written, or -1 upon failure. */
1021 ssize_t written = write(port->fd, buf, count);
1024 RETURN_FAIL("write() failed");
1026 RETURN_VALUE("%d", written);
1030 enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout)
1032 TRACE("%p, %p, %d, %d", port, buf, count, timeout);
1037 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1040 DEBUG("Reading %d bytes from port %s, timeout %d ms", count, port->name, timeout);
1042 DEBUG("Reading %d bytes from port %s, no timeout", count, port->name);
1045 RETURN_VALUE("0", 0);
1048 DWORD bytes_read = 0;
1051 port->timeouts.ReadIntervalTimeout = 0;
1052 port->timeouts.ReadTotalTimeoutConstant = timeout;
1053 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1054 RETURN_FAIL("SetCommTimeouts() failed");
1057 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0) {
1058 if (GetLastError() == ERROR_IO_PENDING) {
1059 DEBUG("Waiting for read to complete");
1060 GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
1061 DEBUG("Read completed, %d/%d bytes read", bytes_read, count);
1062 RETURN_VALUE("%d", bytes_read);
1064 RETURN_FAIL("ReadFile() failed");
1067 DEBUG("Read completed immediately");
1068 RETURN_VALUE("%d", count);
1071 size_t bytes_read = 0;
1072 unsigned char *ptr = (unsigned char *) buf;
1073 struct timeval start, delta, now, end = {0, 0};
1078 /* Get time at start of operation. */
1079 gettimeofday(&start, NULL);
1080 /* Define duration of timeout. */
1081 delta.tv_sec = timeout / 1000;
1082 delta.tv_usec = (timeout % 1000) * 1000;
1083 /* Calculate time at which we should give up. */
1084 timeradd(&start, &delta, &end);
1087 /* Loop until we have the requested number of bytes. */
1088 while (bytes_read < count)
1090 /* Wait until data is available. */
1092 FD_SET(port->fd, &fds);
1094 gettimeofday(&now, NULL);
1095 if (timercmp(&now, &end, >))
1096 /* Timeout has expired. */
1097 RETURN_VALUE("%d", bytes_read);
1098 timersub(&end, &now, &delta);
1100 result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL);
1102 if (errno == EINTR) {
1103 DEBUG("select() call was interrupted, repeating");
1106 RETURN_FAIL("select() failed");
1108 } else if (result == 0) {
1109 DEBUG("read timed out");
1110 RETURN_VALUE("%d", bytes_read);
1114 result = read(port->fd, ptr, count - bytes_read);
1117 if (errno == EAGAIN)
1118 /* This shouldn't happen because we did a select() first, but handle anyway. */
1121 /* This is an actual failure. */
1122 RETURN_FAIL("read() failed");
1125 bytes_read += result;
1129 RETURN_VALUE("%d", bytes_read);
1133 enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count)
1135 TRACE("%p, %p, %d", port, buf, count);
1140 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1142 DEBUG("Reading up to %d bytes from port %s", count, port->name);
1148 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1149 port->timeouts.ReadTotalTimeoutConstant = 0;
1150 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1151 RETURN_FAIL("SetCommTimeouts() failed");
1154 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
1155 RETURN_FAIL("ReadFile() failed");
1157 /* Get number of bytes read. */
1158 GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
1160 RETURN_VALUE("%d", bytes_read);
1164 /* Returns the number of bytes read, or -1 upon failure. */
1165 if ((bytes_read = read(port->fd, buf, count)) < 0) {
1166 if (errno == EAGAIN)
1167 /* No bytes available. */
1170 /* This is an actual failure. */
1171 RETURN_FAIL("read() failed");
1173 RETURN_VALUE("%d", bytes_read);
1177 enum sp_return sp_input_waiting(struct sp_port *port)
1183 DEBUG("Checking input bytes waiting on port %s", port->name);
1189 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1190 RETURN_FAIL("ClearComError() failed");
1191 RETURN_VALUE("%d", comstat.cbInQue);
1194 if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1195 RETURN_FAIL("TIOCINQ ioctl failed");
1196 RETURN_VALUE("%d", bytes_waiting);
1200 enum sp_return sp_output_waiting(struct sp_port *port)
1206 DEBUG("Checking output bytes waiting on port %s", port->name);
1212 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1213 RETURN_FAIL("ClearComError() failed");
1214 RETURN_VALUE("%d", comstat.cbOutQue);
1217 if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1218 RETURN_FAIL("TIOCOUTQ ioctl failed");
1219 RETURN_VALUE("%d", bytes_waiting);
1224 static enum sp_return get_baudrate(int fd, int *baudrate)
1228 TRACE("%d, %p", fd, baudrate);
1230 DEBUG("Getting baud rate");
1232 if (!(data = malloc(get_termios_size())))
1233 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1235 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1237 RETURN_FAIL("getting termios failed");
1240 *baudrate = get_termios_speed(data);
1247 static enum sp_return set_baudrate(int fd, int baudrate)
1251 TRACE("%d, %d", fd, baudrate);
1253 DEBUG("Getting baud rate");
1255 if (!(data = malloc(get_termios_size())))
1256 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1258 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1260 RETURN_FAIL("getting termios failed");
1263 DEBUG("Setting baud rate");
1265 set_termios_speed(data, baudrate);
1267 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1269 RETURN_FAIL("setting termios failed");
1278 static enum sp_return get_flow(int fd, int *flow)
1282 TRACE("%d, %p", fd, flow);
1284 DEBUG("Getting advanced flow control");
1286 if (!(data = malloc(get_termiox_size())))
1287 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1289 if (ioctl(fd, TCGETX, data) < 0) {
1291 RETURN_FAIL("getting termiox failed");
1294 *flow = get_termiox_flow(data);
1301 static enum sp_return set_flow(int fd, int flow)
1305 TRACE("%d, %d", fd, flow);
1307 DEBUG("Getting advanced flow control");
1309 if (!(data = malloc(get_termiox_size())))
1310 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1312 if (ioctl(fd, TCGETX, data) < 0) {
1314 RETURN_FAIL("getting termiox failed");
1317 DEBUG("Setting advanced flow control");
1319 set_termiox_flow(data, flow);
1321 if (ioctl(fd, TCSETX, data) < 0) {
1323 RETURN_FAIL("setting termiox failed");
1330 #endif /* USE_TERMIOX */
1331 #endif /* __linux__ */
1333 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1334 struct sp_port_config *config)
1338 TRACE("%p, %p, %p", port, data, config);
1340 DEBUG("Getting configuration for port %s", port->name);
1343 if (!GetCommState(port->hdl, &data->dcb))
1344 RETURN_FAIL("GetCommState() failed");
1346 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1347 if (data->dcb.BaudRate == std_baudrates[i].index) {
1348 config->baudrate = std_baudrates[i].value;
1353 if (i == NUM_STD_BAUDRATES)
1354 /* BaudRate field can be either an index or a custom baud rate. */
1355 config->baudrate = data->dcb.BaudRate;
1357 config->bits = data->dcb.ByteSize;
1359 if (data->dcb.fParity)
1360 switch (data->dcb.Parity) {
1362 config->parity = SP_PARITY_NONE;
1365 config->parity = SP_PARITY_ODD;
1368 config->parity = SP_PARITY_EVEN;
1371 config->parity = SP_PARITY_MARK;
1374 config->parity = SP_PARITY_SPACE;
1377 config->parity = -1;
1380 config->parity = SP_PARITY_NONE;
1382 switch (data->dcb.StopBits) {
1384 config->stopbits = 1;
1387 config->stopbits = 2;
1390 config->stopbits = -1;
1393 switch (data->dcb.fRtsControl) {
1394 case RTS_CONTROL_DISABLE:
1395 config->rts = SP_RTS_OFF;
1397 case RTS_CONTROL_ENABLE:
1398 config->rts = SP_RTS_ON;
1400 case RTS_CONTROL_HANDSHAKE:
1401 config->rts = SP_RTS_FLOW_CONTROL;
1407 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1409 switch (data->dcb.fDtrControl) {
1410 case DTR_CONTROL_DISABLE:
1411 config->dtr = SP_DTR_OFF;
1413 case DTR_CONTROL_ENABLE:
1414 config->dtr = SP_DTR_ON;
1416 case DTR_CONTROL_HANDSHAKE:
1417 config->dtr = SP_DTR_FLOW_CONTROL;
1423 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1425 if (data->dcb.fInX) {
1426 if (data->dcb.fOutX)
1427 config->xon_xoff = SP_XONXOFF_INOUT;
1429 config->xon_xoff = SP_XONXOFF_IN;
1431 if (data->dcb.fOutX)
1432 config->xon_xoff = SP_XONXOFF_OUT;
1434 config->xon_xoff = SP_XONXOFF_DISABLED;
1439 if (tcgetattr(port->fd, &data->term) < 0)
1440 RETURN_FAIL("tcgetattr() failed");
1442 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1443 RETURN_FAIL("TIOCMGET ioctl failed");
1446 int ret = get_flow(port->fd, &data->flow);
1448 if (ret == SP_ERR_FAIL && errno == EINVAL)
1449 data->termiox_supported = 0;
1451 RETURN_CODEVAL(ret);
1453 data->termiox_supported = 1;
1455 data->termiox_supported = 0;
1458 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1459 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1460 config->baudrate = std_baudrates[i].value;
1465 if (i == NUM_STD_BAUDRATES) {
1467 config->baudrate = (int)data->term.c_ispeed;
1468 #elif defined(__linux__)
1469 TRY(get_baudrate(port->fd, &config->baudrate));
1471 config->baudrate = -1;
1475 switch (data->term.c_cflag & CSIZE) {
1492 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1493 config->parity = SP_PARITY_NONE;
1494 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1495 config->parity = -1;
1497 else if (data->term.c_cflag & CMSPAR)
1498 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1501 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1503 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1505 if (data->term.c_cflag & CRTSCTS) {
1506 config->rts = SP_RTS_FLOW_CONTROL;
1507 config->cts = SP_CTS_FLOW_CONTROL;
1509 if (data->termiox_supported && data->flow & RTS_FLOW)
1510 config->rts = SP_RTS_FLOW_CONTROL;
1512 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1514 config->cts = (data->termiox_supported && data->flow & CTS_FLOW) ?
1515 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1518 if (data->termiox_supported && data->flow & DTR_FLOW)
1519 config->dtr = SP_DTR_FLOW_CONTROL;
1521 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1523 config->dsr = (data->termiox_supported && data->flow & DSR_FLOW) ?
1524 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1526 if (data->term.c_iflag & IXOFF) {
1527 if (data->term.c_iflag & IXON)
1528 config->xon_xoff = SP_XONXOFF_INOUT;
1530 config->xon_xoff = SP_XONXOFF_IN;
1532 if (data->term.c_iflag & IXON)
1533 config->xon_xoff = SP_XONXOFF_OUT;
1535 config->xon_xoff = SP_XONXOFF_DISABLED;
1542 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1543 const struct sp_port_config *config)
1547 BAUD_TYPE baud_nonstd;
1552 int baud_nonstd = 0;
1555 TRACE("%p, %p, %p", port, data, config);
1557 DEBUG("Setting configuration for port %s", port->name);
1560 if (config->baudrate >= 0) {
1561 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1562 if (config->baudrate == std_baudrates[i].value) {
1563 data->dcb.BaudRate = std_baudrates[i].index;
1568 if (i == NUM_STD_BAUDRATES)
1569 data->dcb.BaudRate = config->baudrate;
1572 if (config->bits >= 0)
1573 data->dcb.ByteSize = config->bits;
1575 if (config->parity >= 0) {
1576 switch (config->parity) {
1577 /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
1578 case SP_PARITY_NONE:
1579 data->dcb.Parity = NOPARITY;
1582 data->dcb.Parity = ODDPARITY;
1584 case SP_PARITY_EVEN:
1585 data->dcb.Parity = EVENPARITY;
1587 case SP_PARITY_MARK:
1588 data->dcb.Parity = MARKPARITY;
1590 case SP_PARITY_SPACE:
1591 data->dcb.Parity = SPACEPARITY;
1594 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1598 if (config->stopbits >= 0) {
1599 switch (config->stopbits) {
1600 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1602 data->dcb.StopBits = ONESTOPBIT;
1605 data->dcb.StopBits = TWOSTOPBITS;
1608 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1612 if (config->rts >= 0) {
1613 switch (config->rts) {
1615 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1618 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1620 case SP_RTS_FLOW_CONTROL:
1621 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1624 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1628 if (config->cts >= 0) {
1629 switch (config->cts) {
1631 data->dcb.fOutxCtsFlow = FALSE;
1633 case SP_CTS_FLOW_CONTROL:
1634 data->dcb.fOutxCtsFlow = TRUE;
1637 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1641 if (config->dtr >= 0) {
1642 switch (config->dtr) {
1644 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1647 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1649 case SP_DTR_FLOW_CONTROL:
1650 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1653 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1657 if (config->dsr >= 0) {
1658 switch (config->dsr) {
1660 data->dcb.fOutxDsrFlow = FALSE;
1662 case SP_DSR_FLOW_CONTROL:
1663 data->dcb.fOutxDsrFlow = TRUE;
1666 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1670 if (config->xon_xoff >= 0) {
1671 switch (config->xon_xoff) {
1672 case SP_XONXOFF_DISABLED:
1673 data->dcb.fInX = FALSE;
1674 data->dcb.fOutX = FALSE;
1677 data->dcb.fInX = TRUE;
1678 data->dcb.fOutX = FALSE;
1680 case SP_XONXOFF_OUT:
1681 data->dcb.fInX = FALSE;
1682 data->dcb.fOutX = TRUE;
1684 case SP_XONXOFF_INOUT:
1685 data->dcb.fInX = TRUE;
1686 data->dcb.fOutX = TRUE;
1689 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1693 if (!SetCommState(port->hdl, &data->dcb))
1694 RETURN_FAIL("SetCommState() failed");
1700 if (config->baudrate >= 0) {
1701 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1702 if (config->baudrate == std_baudrates[i].value) {
1703 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1704 RETURN_FAIL("cfsetospeed() failed");
1706 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1707 RETURN_FAIL("cfsetispeed() failed");
1712 /* Non-standard baud rate */
1713 if (i == NUM_STD_BAUDRATES) {
1715 /* Set "dummy" baud rate. */
1716 if (cfsetspeed(&data->term, B9600) < 0)
1717 RETURN_FAIL("cfsetspeed() failed");
1718 baud_nonstd = config->baudrate;
1719 #elif defined(__linux__)
1722 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
1727 if (config->bits >= 0) {
1728 data->term.c_cflag &= ~CSIZE;
1729 switch (config->bits) {
1731 data->term.c_cflag |= CS8;
1734 data->term.c_cflag |= CS7;
1737 data->term.c_cflag |= CS6;
1740 data->term.c_cflag |= CS5;
1743 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
1747 if (config->parity >= 0) {
1748 data->term.c_iflag &= ~IGNPAR;
1749 data->term.c_cflag &= ~(PARENB | PARODD);
1751 data->term.c_cflag &= ~CMSPAR;
1753 switch (config->parity) {
1754 case SP_PARITY_NONE:
1755 data->term.c_iflag |= IGNPAR;
1757 case SP_PARITY_EVEN:
1758 data->term.c_cflag |= PARENB;
1761 data->term.c_cflag |= PARENB | PARODD;
1764 case SP_PARITY_MARK:
1765 data->term.c_cflag |= PARENB | PARODD;
1766 data->term.c_cflag |= CMSPAR;
1768 case SP_PARITY_SPACE:
1769 data->term.c_cflag |= PARENB;
1770 data->term.c_cflag |= CMSPAR;
1773 case SP_PARITY_MARK:
1774 case SP_PARITY_SPACE:
1775 RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
1778 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1782 if (config->stopbits >= 0) {
1783 data->term.c_cflag &= ~CSTOPB;
1784 switch (config->stopbits) {
1786 data->term.c_cflag &= ~CSTOPB;
1789 data->term.c_cflag |= CSTOPB;
1792 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
1796 if (config->rts >= 0 || config->cts >= 0) {
1797 if (data->termiox_supported) {
1798 data->flow &= ~(RTS_FLOW | CTS_FLOW);
1799 switch (config->rts) {
1802 controlbits = TIOCM_RTS;
1803 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1804 RETURN_FAIL("Setting RTS signal level failed");
1806 case SP_RTS_FLOW_CONTROL:
1807 data->flow |= RTS_FLOW;
1812 if (config->cts == SP_CTS_FLOW_CONTROL)
1813 data->flow |= CTS_FLOW;
1815 if (data->flow & (RTS_FLOW | CTS_FLOW))
1816 data->term.c_iflag |= CRTSCTS;
1818 data->term.c_iflag &= ~CRTSCTS;
1820 /* Asymmetric use of RTS/CTS not supported. */
1821 if (data->term.c_iflag & CRTSCTS) {
1822 /* Flow control can only be disabled for both RTS & CTS together. */
1823 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1824 if (config->cts != SP_CTS_IGNORE)
1825 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1827 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1828 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
1829 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1832 /* Flow control can only be enabled for both RTS & CTS together. */
1833 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1834 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
1835 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
1838 if (config->rts >= 0) {
1839 if (config->rts == SP_RTS_FLOW_CONTROL) {
1840 data->term.c_iflag |= CRTSCTS;
1842 controlbits = TIOCM_RTS;
1843 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1845 RETURN_FAIL("Setting RTS signal level failed");
1851 if (config->dtr >= 0 || config->dsr >= 0) {
1852 if (data->termiox_supported) {
1853 data->flow &= ~(DTR_FLOW | DSR_FLOW);
1854 switch (config->dtr) {
1857 controlbits = TIOCM_DTR;
1858 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1859 RETURN_FAIL("Setting DTR signal level failed");
1861 case SP_DTR_FLOW_CONTROL:
1862 data->flow |= DTR_FLOW;
1867 if (config->dsr == SP_DSR_FLOW_CONTROL)
1868 data->flow |= DSR_FLOW;
1870 /* DTR/DSR flow control not supported. */
1871 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
1872 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
1874 if (config->dtr >= 0) {
1875 controlbits = TIOCM_DTR;
1876 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1878 RETURN_FAIL("Setting DTR signal level failed");
1883 if (config->xon_xoff >= 0) {
1884 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
1885 switch (config->xon_xoff) {
1886 case SP_XONXOFF_DISABLED:
1889 data->term.c_iflag |= IXOFF;
1891 case SP_XONXOFF_OUT:
1892 data->term.c_iflag |= IXON | IXANY;
1894 case SP_XONXOFF_INOUT:
1895 data->term.c_iflag |= IXON | IXOFF | IXANY;
1898 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1902 if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
1903 RETURN_FAIL("tcsetattr() failed");
1906 if (baud_nonstd != B0) {
1907 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
1908 RETURN_FAIL("IOSSIOSPEED ioctl failed");
1909 /* Set baud rates in data->term to correct, but incompatible
1910 * with tcsetattr() value, same as delivered by tcgetattr(). */
1911 if (cfsetspeed(&data->term, baud_nonstd) < 0)
1912 RETURN_FAIL("cfsetspeed() failed");
1914 #elif defined(__linux__)
1916 TRY(set_baudrate(port->fd, config->baudrate));
1918 if (data->termiox_supported)
1919 TRY(set_flow(port->fd, data->flow));
1923 #endif /* !_WIN32 */
1928 enum sp_return sp_new_config(struct sp_port_config **config_ptr)
1930 struct sp_port_config *config;
1932 TRACE("%p", config_ptr);
1935 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
1939 if (!(config = malloc(sizeof(struct sp_port_config))))
1940 RETURN_ERROR(SP_ERR_MEM, "config malloc failed");
1942 config->baudrate = -1;
1944 config->parity = -1;
1945 config->stopbits = -1;
1951 *config_ptr = config;
1956 void sp_free_config(struct sp_port_config *config)
1958 TRACE("%p", config);
1961 DEBUG("Null config");
1968 enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config)
1970 struct port_data data;
1972 TRACE("%p, %p", port, config);
1977 RETURN_ERROR(SP_ERR_ARG, "Null config");
1979 TRY(get_config(port, &data, config));
1984 enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config)
1986 struct port_data data;
1987 struct sp_port_config prev_config;
1989 TRACE("%p, %p", port, config);
1994 RETURN_ERROR(SP_ERR_ARG, "Null config");
1996 TRY(get_config(port, &data, &prev_config));
1997 TRY(set_config(port, &data, config));
2002 #define CREATE_ACCESSORS(x, type) \
2003 enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2004 struct port_data data; \
2005 struct sp_port_config config; \
2006 TRACE("%p, %d", port, x); \
2007 CHECK_OPEN_PORT(); \
2008 TRY(get_config(port, &data, &config)); \
2010 TRY(set_config(port, &data, &config)); \
2013 enum sp_return sp_get_config_##x(const struct sp_port_config *config, type *x) { \
2014 TRACE("%p, %p", config, x); \
2016 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2020 enum sp_return sp_set_config_##x(struct sp_port_config *config, type x) { \
2021 TRACE("%p, %d", config, x); \
2023 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2028 CREATE_ACCESSORS(baudrate, int)
2029 CREATE_ACCESSORS(bits, int)
2030 CREATE_ACCESSORS(parity, enum sp_parity)
2031 CREATE_ACCESSORS(stopbits, int)
2032 CREATE_ACCESSORS(rts, enum sp_rts)
2033 CREATE_ACCESSORS(cts, enum sp_cts)
2034 CREATE_ACCESSORS(dtr, enum sp_dtr)
2035 CREATE_ACCESSORS(dsr, enum sp_dsr)
2036 CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2038 enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_flowcontrol flowcontrol)
2041 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2043 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2044 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2046 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2047 config->xon_xoff = SP_XONXOFF_INOUT;
2049 config->xon_xoff = SP_XONXOFF_DISABLED;
2051 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2052 config->rts = SP_RTS_FLOW_CONTROL;
2053 config->cts = SP_CTS_FLOW_CONTROL;
2055 if (config->rts == SP_RTS_FLOW_CONTROL)
2056 config->rts = SP_RTS_ON;
2057 config->cts = SP_CTS_IGNORE;
2060 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2061 config->dtr = SP_DTR_FLOW_CONTROL;
2062 config->dsr = SP_DSR_FLOW_CONTROL;
2064 if (config->dtr == SP_DTR_FLOW_CONTROL)
2065 config->dtr = SP_DTR_ON;
2066 config->dsr = SP_DSR_IGNORE;
2072 enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol)
2074 struct port_data data;
2075 struct sp_port_config config;
2077 TRACE("%p, %d", port, flowcontrol);
2081 TRY(get_config(port, &data, &config));
2083 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2085 TRY(set_config(port, &data, &config));
2090 enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals)
2092 TRACE("%p, %p", port, signals);
2097 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2099 DEBUG("Getting control signals for port %s", port->name);
2104 if (GetCommModemStatus(port->hdl, &bits) == 0)
2105 RETURN_FAIL("GetCommModemStatus() failed");
2106 if (bits & MS_CTS_ON)
2107 *signals |= SP_SIG_CTS;
2108 if (bits & MS_DSR_ON)
2109 *signals |= SP_SIG_DSR;
2110 if (bits & MS_RLSD_ON)
2111 *signals |= SP_SIG_DCD;
2112 if (bits & MS_RING_ON)
2113 *signals |= SP_SIG_RI;
2116 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2117 RETURN_FAIL("TIOCMGET ioctl failed");
2118 if (bits & TIOCM_CTS)
2119 *signals |= SP_SIG_CTS;
2120 if (bits & TIOCM_DSR)
2121 *signals |= SP_SIG_DSR;
2122 if (bits & TIOCM_CAR)
2123 *signals |= SP_SIG_DCD;
2124 if (bits & TIOCM_RNG)
2125 *signals |= SP_SIG_RI;
2130 enum sp_return sp_start_break(struct sp_port *port)
2136 if (SetCommBreak(port->hdl) == 0)
2137 RETURN_FAIL("SetCommBreak() failed");
2139 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2140 RETURN_FAIL("TIOCSBRK ioctl failed");
2146 enum sp_return sp_end_break(struct sp_port *port)
2152 if (ClearCommBreak(port->hdl) == 0)
2153 RETURN_FAIL("ClearCommBreak() failed");
2155 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2156 RETURN_FAIL("TIOCCBRK ioctl failed");
2162 int sp_last_error_code(void)
2166 RETURN_VALUE("%d", GetLastError());
2168 RETURN_VALUE("%d", errno);
2172 char *sp_last_error_message(void)
2178 DWORD error = GetLastError();
2181 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2182 FORMAT_MESSAGE_FROM_SYSTEM |
2183 FORMAT_MESSAGE_IGNORE_INSERTS,
2186 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2190 RETURN_VALUE("%s", message);
2192 RETURN_VALUE("%s", strerror(errno));
2196 void sp_free_error_message(char *message)
2198 TRACE("%s", message);
2209 void sp_set_debug_handler(void (*handler)(const char *format, ...))
2211 TRACE("%p", handler);
2213 sp_debug_handler = handler;
2218 void sp_default_debug_handler(const char *format, ...)
2221 va_start(args, format);
2222 if (getenv("LIBSERIALPORT_DEBUG")) {
2223 fputs("sp: ", stderr);
2224 vfprintf(stderr, format, args);