2 * This file is part of the libserialport project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2010-2015 Uwe Hermann <uwe@hermann-uwe.de>
6 * Copyright (C) 2013-2015 Martin Ling <martin-libserialport@earth.li>
7 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
8 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License as
12 * published by the Free Software Foundation, either version 3 of the
13 * License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "libserialport_internal.h"
26 static const struct std_baudrate std_baudrates[] = {
29 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
30 * have documented CBR_* macros.
32 BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
33 BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
34 BAUD(115200), BAUD(128000), BAUD(256000),
36 BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
37 BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
38 BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
40 #if !defined(__APPLE__) && !defined(__OpenBSD__)
46 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
48 void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
50 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
51 struct sp_port_config *config);
53 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
54 const struct sp_port_config *config);
56 SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
59 #ifndef NO_PORT_METADATA
64 TRACE("%s, %p", portname, port_ptr);
67 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
72 RETURN_ERROR(SP_ERR_ARG, "Null port name");
74 DEBUG_FMT("Building structure for port %s", portname);
76 #if !defined(_WIN32) && defined(HAVE_REALPATH)
78 * get_port_details() below tries to be too smart and figure out
79 * some transport properties from the port name which breaks with
80 * symlinks. Therefore we canonicalize the portname first.
82 char pathbuf[PATH_MAX + 1];
83 char *res = realpath(portname, pathbuf);
85 RETURN_ERROR(SP_ERR_ARG, "Could not retrieve realpath behind port name");
90 if (!(port = malloc(sizeof(struct sp_port))))
91 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
93 len = strlen(portname) + 1;
95 if (!(port->name = malloc(len))) {
97 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
100 memcpy(port->name, portname, len);
103 port->usb_path = NULL;
104 port->hdl = INVALID_HANDLE_VALUE;
105 port->write_buf = NULL;
106 port->write_buf_size = 0;
111 port->description = NULL;
112 port->transport = SP_TRANSPORT_NATIVE;
114 port->usb_address = -1;
117 port->usb_manufacturer = NULL;
118 port->usb_product = NULL;
119 port->usb_serial = NULL;
120 port->bluetooth_address = NULL;
122 #ifndef NO_PORT_METADATA
123 if ((ret = get_port_details(port)) != SP_OK) {
134 SP_API char *sp_get_port_name(const struct sp_port *port)
141 RETURN_STRING(port->name);
144 SP_API char *sp_get_port_description(const struct sp_port *port)
148 if (!port || !port->description)
151 RETURN_STRING(port->description);
154 SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port)
159 RETURN_ERROR(SP_ERR_ARG, "Null port");
161 RETURN_INT(port->transport);
164 SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
165 int *usb_bus,int *usb_address)
170 RETURN_ERROR(SP_ERR_ARG, "Null port");
171 if (port->transport != SP_TRANSPORT_USB)
172 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
173 if (port->usb_bus < 0 || port->usb_address < 0)
174 RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available");
177 *usb_bus = port->usb_bus;
179 *usb_address = port->usb_address;
184 SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
185 int *usb_vid, int *usb_pid)
190 RETURN_ERROR(SP_ERR_ARG, "Null port");
191 if (port->transport != SP_TRANSPORT_USB)
192 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
193 if (port->usb_vid < 0 || port->usb_pid < 0)
194 RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available");
197 *usb_vid = port->usb_vid;
199 *usb_pid = port->usb_pid;
204 SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port)
208 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
211 RETURN_STRING(port->usb_manufacturer);
214 SP_API char *sp_get_port_usb_product(const struct sp_port *port)
218 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
221 RETURN_STRING(port->usb_product);
224 SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
228 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
231 RETURN_STRING(port->usb_serial);
234 SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
238 if (!port || port->transport != SP_TRANSPORT_BLUETOOTH
239 || !port->bluetooth_address)
242 RETURN_STRING(port->bluetooth_address);
245 SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
248 TRACE("%p, %p", port, result_ptr);
251 RETURN_ERROR(SP_ERR_ARG, "Null port");
253 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
256 HANDLE *handle_ptr = result_ptr;
257 *handle_ptr = port->hdl;
259 int *fd_ptr = result_ptr;
266 SP_API enum sp_return sp_copy_port(const struct sp_port *port,
267 struct sp_port **copy_ptr)
269 TRACE("%p, %p", port, copy_ptr);
272 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
277 RETURN_ERROR(SP_ERR_ARG, "Null port");
280 RETURN_ERROR(SP_ERR_ARG, "Null port name");
282 DEBUG("Copying port structure");
284 RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
287 SP_API void sp_free_port(struct sp_port *port)
296 DEBUG("Freeing port structure");
300 if (port->description)
301 free(port->description);
302 if (port->usb_manufacturer)
303 free(port->usb_manufacturer);
304 if (port->usb_product)
305 free(port->usb_product);
306 if (port->usb_serial)
307 free(port->usb_serial);
308 if (port->bluetooth_address)
309 free(port->bluetooth_address);
312 free(port->usb_path);
314 free(port->write_buf);
322 SP_PRIV struct sp_port **list_append(struct sp_port **list,
323 const char *portname)
328 for (count = 0; list[count]; count++)
330 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
333 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
335 list[count + 1] = NULL;
339 sp_free_port_list(list);
343 SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr)
345 #ifndef NO_ENUMERATION
346 struct sp_port **list;
350 TRACE("%p", list_ptr);
353 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
357 #ifdef NO_ENUMERATION
358 RETURN_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
360 DEBUG("Enumerating ports");
362 if (!(list = malloc(sizeof(struct sp_port *))))
363 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
367 ret = list_ports(&list);
372 sp_free_port_list(list);
380 SP_API void sp_free_port_list(struct sp_port **list)
391 DEBUG("Freeing port list");
393 for (i = 0; list[i]; i++)
394 sp_free_port(list[i]);
400 #define CHECK_PORT() do { \
402 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
404 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
407 #define CHECK_PORT_HANDLE() do { \
408 if (port->hdl == INVALID_HANDLE_VALUE) \
409 RETURN_ERROR(SP_ERR_ARG, "Port not open"); \
412 #define CHECK_PORT_HANDLE() do { \
414 RETURN_ERROR(SP_ERR_ARG, "Port not open"); \
417 #define CHECK_OPEN_PORT() do { \
419 CHECK_PORT_HANDLE(); \
423 /** To be called after port receive buffer is emptied. */
424 static enum sp_return restart_wait(struct sp_port *port)
428 if (port->wait_running) {
429 /* Check status of running wait operation. */
430 if (GetOverlappedResult(port->hdl, &port->wait_ovl,
431 &wait_result, FALSE)) {
432 DEBUG("Previous wait completed");
433 port->wait_running = FALSE;
434 } else if (GetLastError() == ERROR_IO_INCOMPLETE) {
435 DEBUG("Previous wait still running");
438 RETURN_FAIL("GetOverlappedResult() failed");
442 if (!port->wait_running) {
443 /* Start new wait operation. */
444 if (WaitCommEvent(port->hdl, &port->events,
446 DEBUG("New wait returned, events already pending");
447 } else if (GetLastError() == ERROR_IO_PENDING) {
448 DEBUG("New wait running in background");
449 port->wait_running = TRUE;
451 RETURN_FAIL("WaitCommEvent() failed");
459 SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
461 struct port_data data;
462 struct sp_port_config config;
465 TRACE("%p, 0x%x", port, flags);
469 if (flags > SP_MODE_READ_WRITE)
470 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
472 DEBUG_FMT("Opening port %s", port->name);
475 DWORD desired_access = 0, flags_and_attributes = 0, errors;
476 char *escaped_port_name;
479 /* Prefix port name with '\\.\' to work with ports above COM9. */
480 if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
481 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
482 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
484 /* Map 'flags' to the OS-specific settings. */
485 flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
486 if (flags & SP_MODE_READ)
487 desired_access |= GENERIC_READ;
488 if (flags & SP_MODE_WRITE)
489 desired_access |= GENERIC_WRITE;
491 port->hdl = CreateFileA(escaped_port_name, desired_access, 0, 0,
492 OPEN_EXISTING, flags_and_attributes, 0);
494 free(escaped_port_name);
496 if (port->hdl == INVALID_HANDLE_VALUE)
497 RETURN_FAIL("Port CreateFile() failed");
499 /* All timeouts initially disabled. */
500 port->timeouts.ReadIntervalTimeout = 0;
501 port->timeouts.ReadTotalTimeoutMultiplier = 0;
502 port->timeouts.ReadTotalTimeoutConstant = 0;
503 port->timeouts.WriteTotalTimeoutMultiplier = 0;
504 port->timeouts.WriteTotalTimeoutConstant = 0;
506 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
508 RETURN_FAIL("SetCommTimeouts() failed");
511 /* Prepare OVERLAPPED structures. */
512 #define INIT_OVERLAPPED(ovl) do { \
513 memset(&port->ovl, 0, sizeof(port->ovl)); \
514 port->ovl.hEvent = INVALID_HANDLE_VALUE; \
515 if ((port->ovl.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL)) \
516 == INVALID_HANDLE_VALUE) { \
518 RETURN_FAIL(#ovl "CreateEvent() failed"); \
522 INIT_OVERLAPPED(read_ovl);
523 INIT_OVERLAPPED(write_ovl);
524 INIT_OVERLAPPED(wait_ovl);
526 /* Set event mask for RX and error events. */
527 if (SetCommMask(port->hdl, EV_RXCHAR | EV_ERR) == 0) {
529 RETURN_FAIL("SetCommMask() failed");
532 port->writing = FALSE;
533 port->wait_running = FALSE;
535 ret = restart_wait(port);
542 int flags_local = O_NONBLOCK | O_NOCTTY | O_CLOEXEC;
544 /* Map 'flags' to the OS-specific settings. */
545 if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
546 flags_local |= O_RDWR;
547 else if (flags & SP_MODE_READ)
548 flags_local |= O_RDONLY;
549 else if (flags & SP_MODE_WRITE)
550 flags_local |= O_WRONLY;
552 if ((port->fd = open(port->name, flags_local)) < 0)
553 RETURN_FAIL("open() failed");
556 ret = get_config(port, &data, &config);
563 /* Set sane port settings. */
565 data.dcb.fBinary = TRUE;
566 data.dcb.fDsrSensitivity = FALSE;
567 data.dcb.fErrorChar = FALSE;
568 data.dcb.fNull = FALSE;
569 data.dcb.fAbortOnError = FALSE;
571 /* Turn off all fancy termios tricks, give us a raw channel. */
572 data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
574 data.term.c_iflag &= ~IUCLC;
576 data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET);
578 data.term.c_oflag &= ~OLCUC;
581 data.term.c_oflag &= ~NLDLY;
584 data.term.c_oflag &= ~CRDLY;
587 data.term.c_oflag &= ~TABDLY;
590 data.term.c_oflag &= ~BSDLY;
593 data.term.c_oflag &= ~VTDLY;
596 data.term.c_oflag &= ~FFDLY;
599 data.term.c_oflag &= ~OFILL;
601 data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
602 data.term.c_cc[VMIN] = 0;
603 data.term.c_cc[VTIME] = 0;
605 /* Ignore modem status lines; enable receiver; leave control lines alone on close. */
606 data.term.c_cflag |= (CLOCAL | CREAD | HUPCL);
610 if (ClearCommError(port->hdl, &errors, &status) == 0)
611 RETURN_FAIL("ClearCommError() failed");
614 ret = set_config(port, &data, &config);
624 SP_API enum sp_return sp_close(struct sp_port *port)
630 DEBUG_FMT("Closing port %s", port->name);
633 /* Returns non-zero upon success, 0 upon failure. */
634 if (CloseHandle(port->hdl) == 0)
635 RETURN_FAIL("Port CloseHandle() failed");
636 port->hdl = INVALID_HANDLE_VALUE;
638 /* Close event handles for overlapped structures. */
639 #define CLOSE_OVERLAPPED(ovl) do { \
640 if (port->ovl.hEvent != INVALID_HANDLE_VALUE && \
641 CloseHandle(port->ovl.hEvent) == 0) \
642 RETURN_FAIL(# ovl "event CloseHandle() failed"); \
644 CLOSE_OVERLAPPED(read_ovl);
645 CLOSE_OVERLAPPED(write_ovl);
646 CLOSE_OVERLAPPED(wait_ovl);
648 if (port->write_buf) {
649 free(port->write_buf);
650 port->write_buf = NULL;
653 /* Returns 0 upon success, -1 upon failure. */
654 if (close(port->fd) == -1)
655 RETURN_FAIL("close() failed");
662 SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
664 TRACE("%p, 0x%x", port, buffers);
668 if (buffers > SP_BUF_BOTH)
669 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
671 const char *buffer_names[] = {"no", "input", "output", "both"};
673 DEBUG_FMT("Flushing %s buffers on port %s",
674 buffer_names[buffers], port->name);
678 if (buffers & SP_BUF_INPUT)
679 flags |= PURGE_RXCLEAR;
680 if (buffers & SP_BUF_OUTPUT)
681 flags |= PURGE_TXCLEAR;
683 /* Returns non-zero upon success, 0 upon failure. */
684 if (PurgeComm(port->hdl, flags) == 0)
685 RETURN_FAIL("PurgeComm() failed");
687 if (buffers & SP_BUF_INPUT)
688 TRY(restart_wait(port));
691 if (buffers == SP_BUF_BOTH)
693 else if (buffers == SP_BUF_INPUT)
695 else if (buffers == SP_BUF_OUTPUT)
698 /* Returns 0 upon success, -1 upon failure. */
699 if (tcflush(port->fd, flags) < 0)
700 RETURN_FAIL("tcflush() failed");
705 SP_API enum sp_return sp_drain(struct sp_port *port)
711 DEBUG_FMT("Draining port %s", port->name);
714 /* Returns non-zero upon success, 0 upon failure. */
715 if (FlushFileBuffers(port->hdl) == 0)
716 RETURN_FAIL("FlushFileBuffers() failed");
721 #if defined(__ANDROID__) && (__ANDROID_API__ < 21)
722 /* Android only has tcdrain from platform 21 onwards.
723 * On previous API versions, use the ioctl directly. */
725 result = ioctl(port->fd, TCSBRK, &arg);
727 result = tcdrain(port->fd);
730 if (errno == EINTR) {
731 DEBUG("tcdrain() was interrupted");
734 RETURN_FAIL("tcdrain() failed");
744 static enum sp_return await_write_completion(struct sp_port *port)
750 /* Wait for previous non-blocking write to complete, if any. */
752 DEBUG("Waiting for previous write to complete");
753 result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
756 RETURN_FAIL("Previous write failed to complete");
757 DEBUG("Previous write completed");
764 SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
765 size_t count, unsigned int timeout_ms)
767 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
772 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
775 DEBUG_FMT("Writing %d bytes to port %s, timeout %d ms",
776 count, port->name, timeout_ms);
778 DEBUG_FMT("Writing %d bytes to port %s, no timeout",
785 DWORD remaining_ms, write_size, bytes_written;
786 size_t remaining_bytes, total_bytes_written = 0;
787 const uint8_t *write_ptr = (uint8_t *) buf;
789 struct timeout timeout;
791 timeout_start(&timeout, timeout_ms);
793 TRY(await_write_completion(port));
795 while (total_bytes_written < count) {
797 if (timeout_check(&timeout))
800 remaining_ms = timeout_remaining_ms(&timeout);
802 if (port->timeouts.WriteTotalTimeoutConstant != remaining_ms) {
803 port->timeouts.WriteTotalTimeoutConstant = remaining_ms;
804 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
805 RETURN_FAIL("SetCommTimeouts() failed");
808 /* Reduce write size if it exceeds the WriteFile limit. */
809 remaining_bytes = count - total_bytes_written;
810 if (remaining_bytes > WRITEFILE_MAX_SIZE)
811 write_size = WRITEFILE_MAX_SIZE;
813 write_size = (DWORD) remaining_bytes;
817 result = WriteFile(port->hdl, write_ptr, write_size, NULL, &port->write_ovl);
819 timeout_update(&timeout);
822 DEBUG("Write completed immediately");
823 bytes_written = write_size;
824 } else if (GetLastError() == ERROR_IO_PENDING) {
825 DEBUG("Waiting for write to complete");
826 if (GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE) == 0) {
827 if (GetLastError() == ERROR_SEM_TIMEOUT) {
828 DEBUG("Write timed out");
831 RETURN_FAIL("GetOverlappedResult() failed");
834 DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, write_size);
836 RETURN_FAIL("WriteFile() failed");
839 write_ptr += bytes_written;
840 total_bytes_written += bytes_written;
843 RETURN_INT((int) total_bytes_written);
845 size_t bytes_written = 0;
846 unsigned char *ptr = (unsigned char *) buf;
847 struct timeout timeout;
851 timeout_start(&timeout, timeout_ms);
854 FD_SET(port->fd, &fds);
856 /* Loop until we have written the requested number of bytes. */
857 while (bytes_written < count) {
859 if (timeout_check(&timeout))
862 result = select(port->fd + 1, NULL, &fds, NULL, timeout_timeval(&timeout));
864 timeout_update(&timeout);
867 if (errno == EINTR) {
868 DEBUG("select() call was interrupted, repeating");
871 RETURN_FAIL("select() failed");
873 } else if (result == 0) {
874 /* Timeout has expired. */
879 result = write(port->fd, ptr, count - bytes_written);
883 /* This shouldn't happen because we did a select() first, but handle anyway. */
886 /* This is an actual failure. */
887 RETURN_FAIL("write() failed");
890 bytes_written += result;
894 if (bytes_written < count)
895 DEBUG("Write timed out");
897 RETURN_INT(bytes_written);
901 SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
902 const void *buf, size_t count)
904 TRACE("%p, %p, %d", port, buf, count);
909 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
911 DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
919 /* Check whether previous write is complete. */
921 if (HasOverlappedIoCompleted(&port->write_ovl)) {
922 DEBUG("Previous write completed");
925 DEBUG("Previous write not complete");
926 /* Can't take a new write until the previous one finishes. */
932 if (port->timeouts.WriteTotalTimeoutConstant != 0) {
933 port->timeouts.WriteTotalTimeoutConstant = 0;
934 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
935 RETURN_FAIL("SetCommTimeouts() failed");
938 /* Reduce count if it exceeds the WriteFile limit. */
939 if (count > WRITEFILE_MAX_SIZE)
940 count = WRITEFILE_MAX_SIZE;
942 /* Copy data to our write buffer. */
943 buf_bytes = min(port->write_buf_size, count);
944 memcpy(port->write_buf, buf, buf_bytes);
946 /* Start asynchronous write. */
947 if (WriteFile(port->hdl, port->write_buf, (DWORD) buf_bytes, NULL, &port->write_ovl) == 0) {
948 if (GetLastError() == ERROR_IO_PENDING) {
949 if ((port->writing = !HasOverlappedIoCompleted(&port->write_ovl)))
950 DEBUG("Asynchronous write completed immediately");
952 DEBUG("Asynchronous write running");
954 /* Actual failure of some kind. */
955 RETURN_FAIL("WriteFile() failed");
959 DEBUG("All bytes written immediately");
961 RETURN_INT((int) buf_bytes);
963 /* Returns the number of bytes written, or -1 upon failure. */
964 ssize_t written = write(port->fd, buf, count);
968 // Buffer is full, no bytes written.
971 RETURN_FAIL("write() failed");
979 /* Restart wait operation if buffer was emptied. */
980 static enum sp_return restart_wait_if_needed(struct sp_port *port, unsigned int bytes_read)
988 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
989 RETURN_FAIL("ClearCommError() failed");
991 if (comstat.cbInQue == 0)
992 TRY(restart_wait(port));
998 SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
999 size_t count, unsigned int timeout_ms)
1001 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
1006 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1009 DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms",
1010 count, port->name, timeout_ms);
1012 DEBUG_FMT("Reading %d bytes from port %s, no timeout",
1022 if (port->timeouts.ReadIntervalTimeout != 0 ||
1023 port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
1024 port->timeouts.ReadTotalTimeoutConstant != timeout_ms) {
1025 port->timeouts.ReadIntervalTimeout = 0;
1026 port->timeouts.ReadTotalTimeoutMultiplier = 0;
1027 port->timeouts.ReadTotalTimeoutConstant = timeout_ms;
1028 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1029 RETURN_FAIL("SetCommTimeouts() failed");
1033 if (ReadFile(port->hdl, buf, (DWORD) count, NULL, &port->read_ovl)) {
1034 DEBUG("Read completed immediately");
1035 bytes_read = (DWORD) count;
1036 } else if (GetLastError() == ERROR_IO_PENDING) {
1037 DEBUG("Waiting for read to complete");
1038 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1039 RETURN_FAIL("GetOverlappedResult() failed");
1040 DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
1042 RETURN_FAIL("ReadFile() failed");
1045 TRY(restart_wait_if_needed(port, bytes_read));
1047 RETURN_INT((int) bytes_read);
1050 size_t bytes_read = 0;
1051 unsigned char *ptr = (unsigned char *) buf;
1052 struct timeout timeout;
1056 timeout_start(&timeout, timeout_ms);
1059 FD_SET(port->fd, &fds);
1061 /* Loop until we have the requested number of bytes. */
1062 while (bytes_read < count) {
1064 if (timeout_check(&timeout))
1065 /* Timeout has expired. */
1068 result = select(port->fd + 1, &fds, NULL, NULL, timeout_timeval(&timeout));
1070 timeout_update(&timeout);
1073 if (errno == EINTR) {
1074 DEBUG("select() call was interrupted, repeating");
1077 RETURN_FAIL("select() failed");
1079 } else if (result == 0) {
1080 /* Timeout has expired. */
1085 result = read(port->fd, ptr, count - bytes_read);
1088 if (errno == EAGAIN)
1090 * This shouldn't happen because we did a
1091 * select() first, but handle anyway.
1095 /* This is an actual failure. */
1096 RETURN_FAIL("read() failed");
1099 bytes_read += result;
1103 if (bytes_read < count)
1104 DEBUG("Read timed out");
1106 RETURN_INT(bytes_read);
1110 SP_API enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf,
1111 size_t count, unsigned int timeout_ms)
1113 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
1118 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1121 RETURN_ERROR(SP_ERR_ARG, "Zero count");
1124 DEBUG_FMT("Reading next max %d bytes from port %s, timeout %d ms",
1125 count, port->name, timeout_ms);
1127 DEBUG_FMT("Reading next max %d bytes from port %s, no timeout",
1131 DWORD bytes_read = 0;
1133 /* If timeout_ms == 0, set maximum timeout. */
1134 DWORD timeout_val = (timeout_ms == 0 ? MAXDWORD - 1 : timeout_ms);
1137 if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1138 port->timeouts.ReadTotalTimeoutMultiplier != MAXDWORD ||
1139 port->timeouts.ReadTotalTimeoutConstant != timeout_val) {
1140 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1141 port->timeouts.ReadTotalTimeoutMultiplier = MAXDWORD;
1142 port->timeouts.ReadTotalTimeoutConstant = timeout_val;
1143 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1144 RETURN_FAIL("SetCommTimeouts() failed");
1147 /* Loop until we have at least one byte, or timeout is reached. */
1148 while (bytes_read == 0) {
1150 if (ReadFile(port->hdl, buf, (DWORD) count, &bytes_read, &port->read_ovl)) {
1151 DEBUG("Read completed immediately");
1152 } else if (GetLastError() == ERROR_IO_PENDING) {
1153 DEBUG("Waiting for read to complete");
1154 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1155 RETURN_FAIL("GetOverlappedResult() failed");
1156 if (bytes_read > 0) {
1157 DEBUG("Read completed");
1158 } else if (timeout_ms > 0) {
1159 DEBUG("Read timed out");
1162 DEBUG("Restarting read");
1165 RETURN_FAIL("ReadFile() failed");
1169 TRY(restart_wait_if_needed(port, bytes_read));
1171 RETURN_INT(bytes_read);
1174 size_t bytes_read = 0;
1175 struct timeout timeout;
1179 timeout_start(&timeout, timeout_ms);
1182 FD_SET(port->fd, &fds);
1184 /* Loop until we have at least one byte, or timeout is reached. */
1185 while (bytes_read == 0) {
1187 if (timeout_check(&timeout))
1188 /* Timeout has expired. */
1191 result = select(port->fd + 1, &fds, NULL, NULL, timeout_timeval(&timeout));
1193 timeout_update(&timeout);
1196 if (errno == EINTR) {
1197 DEBUG("select() call was interrupted, repeating");
1200 RETURN_FAIL("select() failed");
1202 } else if (result == 0) {
1203 /* Timeout has expired. */
1208 result = read(port->fd, buf, count);
1211 if (errno == EAGAIN)
1212 /* This shouldn't happen because we did a select() first, but handle anyway. */
1215 /* This is an actual failure. */
1216 RETURN_FAIL("read() failed");
1219 bytes_read = result;
1222 if (bytes_read == 0)
1223 DEBUG("Read timed out");
1225 RETURN_INT(bytes_read);
1229 SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
1232 TRACE("%p, %p, %d", port, buf, count);
1237 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1239 DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
1245 if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1246 port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
1247 port->timeouts.ReadTotalTimeoutConstant != 0) {
1248 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1249 port->timeouts.ReadTotalTimeoutMultiplier = 0;
1250 port->timeouts.ReadTotalTimeoutConstant = 0;
1251 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1252 RETURN_FAIL("SetCommTimeouts() failed");
1256 if (ReadFile(port->hdl, buf, (DWORD) count, NULL, &port->read_ovl) == 0)
1257 if (GetLastError() != ERROR_IO_PENDING)
1258 RETURN_FAIL("ReadFile() failed");
1260 /* Get number of bytes read. */
1261 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, FALSE) == 0)
1262 RETURN_FAIL("GetOverlappedResult() failed");
1264 TRY(restart_wait_if_needed(port, bytes_read));
1266 RETURN_INT(bytes_read);
1270 /* Returns the number of bytes read, or -1 upon failure. */
1271 if ((bytes_read = read(port->fd, buf, count)) < 0) {
1272 if (errno == EAGAIN)
1273 /* No bytes available. */
1276 /* This is an actual failure. */
1277 RETURN_FAIL("read() failed");
1279 RETURN_INT(bytes_read);
1283 SP_API enum sp_return sp_input_waiting(struct sp_port *port)
1289 DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
1295 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1296 RETURN_FAIL("ClearCommError() failed");
1297 RETURN_INT(comstat.cbInQue);
1300 if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1301 RETURN_FAIL("TIOCINQ ioctl failed");
1302 RETURN_INT(bytes_waiting);
1306 SP_API enum sp_return sp_output_waiting(struct sp_port *port)
1311 /* TIOCOUTQ is not defined in Cygwin headers */
1312 RETURN_ERROR(SP_ERR_SUPP,
1313 "Getting output bytes waiting is not supported on Cygwin");
1317 DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
1323 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1324 RETURN_FAIL("ClearCommError() failed");
1325 RETURN_INT(comstat.cbOutQue);
1328 if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1329 RETURN_FAIL("TIOCOUTQ ioctl failed");
1330 RETURN_INT(bytes_waiting);
1335 SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
1337 struct sp_event_set *result;
1339 TRACE("%p", result_ptr);
1342 RETURN_ERROR(SP_ERR_ARG, "Null result");
1346 if (!(result = malloc(sizeof(struct sp_event_set))))
1347 RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
1349 memset(result, 0, sizeof(struct sp_event_set));
1351 *result_ptr = result;
1356 static enum sp_return add_handle(struct sp_event_set *event_set,
1357 event_handle handle, enum sp_event mask)
1360 enum sp_event *new_masks;
1362 TRACE("%p, %d, %d", event_set, handle, mask);
1364 if (!(new_handles = realloc(event_set->handles,
1365 sizeof(event_handle) * (event_set->count + 1))))
1366 RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed");
1368 event_set->handles = new_handles;
1370 if (!(new_masks = realloc(event_set->masks,
1371 sizeof(enum sp_event) * (event_set->count + 1))))
1372 RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed");
1374 event_set->masks = new_masks;
1376 ((event_handle *) event_set->handles)[event_set->count] = handle;
1377 event_set->masks[event_set->count] = mask;
1384 SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1385 const struct sp_port *port, enum sp_event mask)
1387 TRACE("%p, %p, %d", event_set, port, mask);
1390 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1393 RETURN_ERROR(SP_ERR_ARG, "Null port");
1395 if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
1396 RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
1402 enum sp_event handle_mask;
1403 if ((handle_mask = mask & SP_EVENT_TX_READY))
1404 TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
1405 if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
1406 TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
1408 TRY(add_handle(event_set, port->fd, mask));
1414 SP_API void sp_free_event_set(struct sp_event_set *event_set)
1416 TRACE("%p", event_set);
1419 DEBUG("Null event set");
1423 DEBUG("Freeing event set");
1425 if (event_set->handles)
1426 free(event_set->handles);
1427 if (event_set->masks)
1428 free(event_set->masks);
1435 SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
1436 unsigned int timeout_ms)
1438 TRACE("%p, %d", event_set, timeout_ms);
1441 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1444 if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
1445 timeout_ms ? timeout_ms : INFINITE) == WAIT_FAILED)
1446 RETURN_FAIL("WaitForMultipleObjects() failed");
1450 struct timeout timeout;
1453 struct pollfd *pollfds;
1456 if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
1457 RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
1459 for (i = 0; i < event_set->count; i++) {
1460 pollfds[i].fd = ((int *)event_set->handles)[i];
1461 pollfds[i].events = 0;
1462 pollfds[i].revents = 0;
1463 if (event_set->masks[i] & SP_EVENT_RX_READY)
1464 pollfds[i].events |= POLLIN;
1465 if (event_set->masks[i] & SP_EVENT_TX_READY)
1466 pollfds[i].events |= POLLOUT;
1467 if (event_set->masks[i] & SP_EVENT_ERROR)
1468 pollfds[i].events |= POLLERR;
1471 timeout_start(&timeout, timeout_ms);
1472 timeout_limit(&timeout, INT_MAX);
1474 /* Loop until an event occurs. */
1477 if (timeout_check(&timeout)) {
1478 DEBUG("Wait timed out");
1482 poll_timeout = (int) timeout_remaining_ms(&timeout);
1483 if (poll_timeout == 0)
1486 result = poll(pollfds, event_set->count, poll_timeout);
1488 timeout_update(&timeout);
1491 if (errno == EINTR) {
1492 DEBUG("poll() call was interrupted, repeating");
1496 RETURN_FAIL("poll() failed");
1498 } else if (result == 0) {
1499 DEBUG("poll() timed out");
1500 if (!timeout.overflow)
1503 DEBUG("poll() completed");
1513 #ifdef USE_TERMIOS_SPEED
1514 static enum sp_return get_baudrate(int fd, int *baudrate)
1518 TRACE("%d, %p", fd, baudrate);
1520 DEBUG("Getting baud rate");
1522 if (!(data = malloc(get_termios_size())))
1523 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1525 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1527 RETURN_FAIL("Getting termios failed");
1530 *baudrate = get_termios_speed(data);
1537 static enum sp_return set_baudrate(int fd, int baudrate)
1541 TRACE("%d, %d", fd, baudrate);
1543 DEBUG("Getting baud rate");
1545 if (!(data = malloc(get_termios_size())))
1546 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1548 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1550 RETURN_FAIL("Getting termios failed");
1553 DEBUG("Setting baud rate");
1555 set_termios_speed(data, baudrate);
1557 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1559 RETURN_FAIL("Setting termios failed");
1566 #endif /* USE_TERMIOS_SPEED */
1569 static enum sp_return get_flow(int fd, struct port_data *data)
1573 TRACE("%d, %p", fd, data);
1575 DEBUG("Getting advanced flow control");
1577 if (!(termx = malloc(get_termiox_size())))
1578 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1580 if (ioctl(fd, TCGETX, termx) < 0) {
1582 RETURN_FAIL("Getting termiox failed");
1585 get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
1586 &data->dtr_flow, &data->dsr_flow);
1593 static enum sp_return set_flow(int fd, struct port_data *data)
1597 TRACE("%d, %p", fd, data);
1599 DEBUG("Getting advanced flow control");
1601 if (!(termx = malloc(get_termiox_size())))
1602 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1604 if (ioctl(fd, TCGETX, termx) < 0) {
1606 RETURN_FAIL("Getting termiox failed");
1609 DEBUG("Setting advanced flow control");
1611 set_termiox_flow(termx, data->rts_flow, data->cts_flow,
1612 data->dtr_flow, data->dsr_flow);
1614 if (ioctl(fd, TCSETX, termx) < 0) {
1616 RETURN_FAIL("Setting termiox failed");
1623 #endif /* USE_TERMIOX */
1625 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1626 struct sp_port_config *config)
1630 TRACE("%p, %p, %p", port, data, config);
1632 DEBUG_FMT("Getting configuration for port %s", port->name);
1635 if (!GetCommState(port->hdl, &data->dcb))
1636 RETURN_FAIL("GetCommState() failed");
1638 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1639 if (data->dcb.BaudRate == std_baudrates[i].index) {
1640 config->baudrate = std_baudrates[i].value;
1645 if (i == NUM_STD_BAUDRATES)
1646 /* BaudRate field can be either an index or a custom baud rate. */
1647 config->baudrate = data->dcb.BaudRate;
1649 config->bits = data->dcb.ByteSize;
1651 if (data->dcb.fParity)
1652 switch (data->dcb.Parity) {
1654 config->parity = SP_PARITY_NONE;
1657 config->parity = SP_PARITY_ODD;
1660 config->parity = SP_PARITY_EVEN;
1663 config->parity = SP_PARITY_MARK;
1666 config->parity = SP_PARITY_SPACE;
1669 config->parity = -1;
1672 config->parity = SP_PARITY_NONE;
1674 switch (data->dcb.StopBits) {
1676 config->stopbits = 1;
1679 config->stopbits = 2;
1682 config->stopbits = -1;
1685 switch (data->dcb.fRtsControl) {
1686 case RTS_CONTROL_DISABLE:
1687 config->rts = SP_RTS_OFF;
1689 case RTS_CONTROL_ENABLE:
1690 config->rts = SP_RTS_ON;
1692 case RTS_CONTROL_HANDSHAKE:
1693 config->rts = SP_RTS_FLOW_CONTROL;
1699 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1701 switch (data->dcb.fDtrControl) {
1702 case DTR_CONTROL_DISABLE:
1703 config->dtr = SP_DTR_OFF;
1705 case DTR_CONTROL_ENABLE:
1706 config->dtr = SP_DTR_ON;
1708 case DTR_CONTROL_HANDSHAKE:
1709 config->dtr = SP_DTR_FLOW_CONTROL;
1715 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1717 if (data->dcb.fInX) {
1718 if (data->dcb.fOutX)
1719 config->xon_xoff = SP_XONXOFF_INOUT;
1721 config->xon_xoff = SP_XONXOFF_IN;
1723 if (data->dcb.fOutX)
1724 config->xon_xoff = SP_XONXOFF_OUT;
1726 config->xon_xoff = SP_XONXOFF_DISABLED;
1731 if (tcgetattr(port->fd, &data->term) < 0)
1732 RETURN_FAIL("tcgetattr() failed");
1734 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1735 RETURN_FAIL("TIOCMGET ioctl failed");
1738 int ret = get_flow(port->fd, data);
1740 if (ret == SP_ERR_FAIL && errno == EINVAL)
1741 data->termiox_supported = 0;
1743 RETURN_CODEVAL(ret);
1745 data->termiox_supported = 1;
1747 data->termiox_supported = 0;
1750 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1751 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1752 config->baudrate = std_baudrates[i].value;
1757 if (i == NUM_STD_BAUDRATES) {
1759 config->baudrate = (int)data->term.c_ispeed;
1760 #elif defined(USE_TERMIOS_SPEED)
1761 TRY(get_baudrate(port->fd, &config->baudrate));
1763 config->baudrate = -1;
1767 switch (data->term.c_cflag & CSIZE) {
1784 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1785 config->parity = SP_PARITY_NONE;
1786 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1787 config->parity = -1;
1789 else if (data->term.c_cflag & CMSPAR)
1790 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1793 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1795 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1797 if (data->term.c_cflag & CRTSCTS) {
1798 config->rts = SP_RTS_FLOW_CONTROL;
1799 config->cts = SP_CTS_FLOW_CONTROL;
1801 if (data->termiox_supported && data->rts_flow)
1802 config->rts = SP_RTS_FLOW_CONTROL;
1804 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1806 config->cts = (data->termiox_supported && data->cts_flow) ?
1807 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1810 if (data->termiox_supported && data->dtr_flow)
1811 config->dtr = SP_DTR_FLOW_CONTROL;
1813 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1815 config->dsr = (data->termiox_supported && data->dsr_flow) ?
1816 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1818 if (data->term.c_iflag & IXOFF) {
1819 if (data->term.c_iflag & IXON)
1820 config->xon_xoff = SP_XONXOFF_INOUT;
1822 config->xon_xoff = SP_XONXOFF_IN;
1824 if (data->term.c_iflag & IXON)
1825 config->xon_xoff = SP_XONXOFF_OUT;
1827 config->xon_xoff = SP_XONXOFF_DISABLED;
1834 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1835 const struct sp_port_config *config)
1839 BAUD_TYPE baud_nonstd;
1843 #ifdef USE_TERMIOS_SPEED
1844 int baud_nonstd = 0;
1847 TRACE("%p, %p, %p", port, data, config);
1849 DEBUG_FMT("Setting configuration for port %s", port->name);
1854 TRY(await_write_completion(port));
1856 if (config->baudrate >= 0) {
1857 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1858 if (config->baudrate == std_baudrates[i].value) {
1859 data->dcb.BaudRate = std_baudrates[i].index;
1864 if (i == NUM_STD_BAUDRATES)
1865 data->dcb.BaudRate = config->baudrate;
1867 /* Allocate write buffer for 50ms of data at baud rate. */
1868 port->write_buf_size = max(config->baudrate / (8 * 20), 1);
1869 new_buf = realloc(port->write_buf, port->write_buf_size);
1871 RETURN_ERROR(SP_ERR_MEM, "Allocating write buffer failed");
1872 port->write_buf = new_buf;
1875 if (config->bits >= 0)
1876 data->dcb.ByteSize = config->bits;
1878 if (config->parity >= 0) {
1879 switch (config->parity) {
1880 case SP_PARITY_NONE:
1881 data->dcb.Parity = NOPARITY;
1884 data->dcb.Parity = ODDPARITY;
1886 case SP_PARITY_EVEN:
1887 data->dcb.Parity = EVENPARITY;
1889 case SP_PARITY_MARK:
1890 data->dcb.Parity = MARKPARITY;
1892 case SP_PARITY_SPACE:
1893 data->dcb.Parity = SPACEPARITY;
1896 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1900 if (config->stopbits >= 0) {
1901 switch (config->stopbits) {
1902 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1904 data->dcb.StopBits = ONESTOPBIT;
1907 data->dcb.StopBits = TWOSTOPBITS;
1910 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1914 if (config->rts >= 0) {
1915 switch (config->rts) {
1917 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1920 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1922 case SP_RTS_FLOW_CONTROL:
1923 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1926 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1930 if (config->cts >= 0) {
1931 switch (config->cts) {
1933 data->dcb.fOutxCtsFlow = FALSE;
1935 case SP_CTS_FLOW_CONTROL:
1936 data->dcb.fOutxCtsFlow = TRUE;
1939 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1943 if (config->dtr >= 0) {
1944 switch (config->dtr) {
1946 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1949 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1951 case SP_DTR_FLOW_CONTROL:
1952 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1955 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1959 if (config->dsr >= 0) {
1960 switch (config->dsr) {
1962 data->dcb.fOutxDsrFlow = FALSE;
1964 case SP_DSR_FLOW_CONTROL:
1965 data->dcb.fOutxDsrFlow = TRUE;
1968 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1972 if (config->xon_xoff >= 0) {
1973 switch (config->xon_xoff) {
1974 case SP_XONXOFF_DISABLED:
1975 data->dcb.fInX = FALSE;
1976 data->dcb.fOutX = FALSE;
1979 data->dcb.fInX = TRUE;
1980 data->dcb.fOutX = FALSE;
1982 case SP_XONXOFF_OUT:
1983 data->dcb.fInX = FALSE;
1984 data->dcb.fOutX = TRUE;
1986 case SP_XONXOFF_INOUT:
1987 data->dcb.fInX = TRUE;
1988 data->dcb.fOutX = TRUE;
1991 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1995 if (!SetCommState(port->hdl, &data->dcb))
1996 RETURN_FAIL("SetCommState() failed");
2002 if (config->baudrate >= 0) {
2003 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
2004 if (config->baudrate == std_baudrates[i].value) {
2005 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
2006 RETURN_FAIL("cfsetospeed() failed");
2008 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
2009 RETURN_FAIL("cfsetispeed() failed");
2014 /* Non-standard baud rate */
2015 if (i == NUM_STD_BAUDRATES) {
2017 /* Set "dummy" baud rate. */
2018 if (cfsetspeed(&data->term, B9600) < 0)
2019 RETURN_FAIL("cfsetspeed() failed");
2020 baud_nonstd = config->baudrate;
2021 #elif defined(USE_TERMIOS_SPEED)
2024 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
2029 if (config->bits >= 0) {
2030 data->term.c_cflag &= ~CSIZE;
2031 switch (config->bits) {
2033 data->term.c_cflag |= CS8;
2036 data->term.c_cflag |= CS7;
2039 data->term.c_cflag |= CS6;
2042 data->term.c_cflag |= CS5;
2045 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
2049 if (config->parity >= 0) {
2050 data->term.c_iflag &= ~IGNPAR;
2051 data->term.c_cflag &= ~(PARENB | PARODD);
2053 data->term.c_cflag &= ~CMSPAR;
2055 switch (config->parity) {
2056 case SP_PARITY_NONE:
2057 data->term.c_iflag |= IGNPAR;
2059 case SP_PARITY_EVEN:
2060 data->term.c_cflag |= PARENB;
2063 data->term.c_cflag |= PARENB | PARODD;
2066 case SP_PARITY_MARK:
2067 data->term.c_cflag |= PARENB | PARODD;
2068 data->term.c_cflag |= CMSPAR;
2070 case SP_PARITY_SPACE:
2071 data->term.c_cflag |= PARENB;
2072 data->term.c_cflag |= CMSPAR;
2075 case SP_PARITY_MARK:
2076 case SP_PARITY_SPACE:
2077 RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
2080 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
2084 if (config->stopbits >= 0) {
2085 data->term.c_cflag &= ~CSTOPB;
2086 switch (config->stopbits) {
2088 data->term.c_cflag &= ~CSTOPB;
2091 data->term.c_cflag |= CSTOPB;
2094 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
2098 if (config->rts >= 0 || config->cts >= 0) {
2099 if (data->termiox_supported) {
2100 data->rts_flow = data->cts_flow = 0;
2101 switch (config->rts) {
2104 controlbits = TIOCM_RTS;
2105 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
2106 RETURN_FAIL("Setting RTS signal level failed");
2108 case SP_RTS_FLOW_CONTROL:
2114 if (config->cts == SP_CTS_FLOW_CONTROL)
2117 if (data->rts_flow && data->cts_flow)
2118 data->term.c_iflag |= CRTSCTS;
2120 data->term.c_iflag &= ~CRTSCTS;
2122 /* Asymmetric use of RTS/CTS not supported. */
2123 if (data->term.c_iflag & CRTSCTS) {
2124 /* Flow control can only be disabled for both RTS & CTS together. */
2125 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
2126 if (config->cts != SP_CTS_IGNORE)
2127 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
2129 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
2130 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
2131 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
2134 /* Flow control can only be enabled for both RTS & CTS together. */
2135 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
2136 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
2137 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
2140 if (config->rts >= 0) {
2141 if (config->rts == SP_RTS_FLOW_CONTROL) {
2142 data->term.c_iflag |= CRTSCTS;
2144 controlbits = TIOCM_RTS;
2145 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
2147 RETURN_FAIL("Setting RTS signal level failed");
2153 if (config->dtr >= 0 || config->dsr >= 0) {
2154 if (data->termiox_supported) {
2155 data->dtr_flow = data->dsr_flow = 0;
2156 switch (config->dtr) {
2159 controlbits = TIOCM_DTR;
2160 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
2161 RETURN_FAIL("Setting DTR signal level failed");
2163 case SP_DTR_FLOW_CONTROL:
2169 if (config->dsr == SP_DSR_FLOW_CONTROL)
2172 /* DTR/DSR flow control not supported. */
2173 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
2174 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
2176 if (config->dtr >= 0) {
2177 controlbits = TIOCM_DTR;
2178 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
2180 RETURN_FAIL("Setting DTR signal level failed");
2185 if (config->xon_xoff >= 0) {
2186 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
2187 switch (config->xon_xoff) {
2188 case SP_XONXOFF_DISABLED:
2191 data->term.c_iflag |= IXOFF;
2193 case SP_XONXOFF_OUT:
2194 data->term.c_iflag |= IXON | IXANY;
2196 case SP_XONXOFF_INOUT:
2197 data->term.c_iflag |= IXON | IXOFF | IXANY;
2200 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2204 if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
2205 RETURN_FAIL("tcsetattr() failed");
2208 if (baud_nonstd != B0) {
2209 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
2210 RETURN_FAIL("IOSSIOSPEED ioctl failed");
2212 * Set baud rates in data->term to correct, but incompatible
2213 * with tcsetattr() value, same as delivered by tcgetattr().
2215 if (cfsetspeed(&data->term, baud_nonstd) < 0)
2216 RETURN_FAIL("cfsetspeed() failed");
2218 #elif defined(__linux__)
2219 #ifdef USE_TERMIOS_SPEED
2221 TRY(set_baudrate(port->fd, config->baudrate));
2224 if (data->termiox_supported)
2225 TRY(set_flow(port->fd, data));
2229 #endif /* !_WIN32 */
2234 SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
2236 struct sp_port_config *config;
2238 TRACE("%p", config_ptr);
2241 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2245 if (!(config = malloc(sizeof(struct sp_port_config))))
2246 RETURN_ERROR(SP_ERR_MEM, "Config malloc failed");
2248 config->baudrate = -1;
2250 config->parity = -1;
2251 config->stopbits = -1;
2257 *config_ptr = config;
2262 SP_API void sp_free_config(struct sp_port_config *config)
2264 TRACE("%p", config);
2267 DEBUG("Null config");
2274 SP_API enum sp_return sp_get_config(struct sp_port *port,
2275 struct sp_port_config *config)
2277 struct port_data data;
2279 TRACE("%p, %p", port, config);
2284 RETURN_ERROR(SP_ERR_ARG, "Null config");
2286 TRY(get_config(port, &data, config));
2291 SP_API enum sp_return sp_set_config(struct sp_port *port,
2292 const struct sp_port_config *config)
2294 struct port_data data;
2295 struct sp_port_config prev_config;
2297 TRACE("%p, %p", port, config);
2302 RETURN_ERROR(SP_ERR_ARG, "Null config");
2304 TRY(get_config(port, &data, &prev_config));
2305 TRY(set_config(port, &data, config));
2310 #define CREATE_ACCESSORS(x, type) \
2311 SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2312 struct port_data data; \
2313 struct sp_port_config config; \
2314 TRACE("%p, %d", port, x); \
2315 CHECK_OPEN_PORT(); \
2316 TRY(get_config(port, &data, &config)); \
2318 TRY(set_config(port, &data, &config)); \
2321 SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \
2323 TRACE("%p, %p", config, x); \
2325 RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); \
2327 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2331 SP_API enum sp_return sp_set_config_##x(struct sp_port_config *config, \
2333 TRACE("%p, %d", config, x); \
2335 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2340 CREATE_ACCESSORS(baudrate, int)
2341 CREATE_ACCESSORS(bits, int)
2342 CREATE_ACCESSORS(parity, enum sp_parity)
2343 CREATE_ACCESSORS(stopbits, int)
2344 CREATE_ACCESSORS(rts, enum sp_rts)
2345 CREATE_ACCESSORS(cts, enum sp_cts)
2346 CREATE_ACCESSORS(dtr, enum sp_dtr)
2347 CREATE_ACCESSORS(dsr, enum sp_dsr)
2348 CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2350 SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config,
2351 enum sp_flowcontrol flowcontrol)
2354 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2356 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2357 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2359 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2360 config->xon_xoff = SP_XONXOFF_INOUT;
2362 config->xon_xoff = SP_XONXOFF_DISABLED;
2364 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2365 config->rts = SP_RTS_FLOW_CONTROL;
2366 config->cts = SP_CTS_FLOW_CONTROL;
2368 if (config->rts == SP_RTS_FLOW_CONTROL)
2369 config->rts = SP_RTS_ON;
2370 config->cts = SP_CTS_IGNORE;
2373 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2374 config->dtr = SP_DTR_FLOW_CONTROL;
2375 config->dsr = SP_DSR_FLOW_CONTROL;
2377 if (config->dtr == SP_DTR_FLOW_CONTROL)
2378 config->dtr = SP_DTR_ON;
2379 config->dsr = SP_DSR_IGNORE;
2385 SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port,
2386 enum sp_flowcontrol flowcontrol)
2388 struct port_data data;
2389 struct sp_port_config config;
2391 TRACE("%p, %d", port, flowcontrol);
2395 TRY(get_config(port, &data, &config));
2397 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2399 TRY(set_config(port, &data, &config));
2404 SP_API enum sp_return sp_get_signals(struct sp_port *port,
2405 enum sp_signal *signals)
2407 TRACE("%p, %p", port, signals);
2412 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2414 DEBUG_FMT("Getting control signals for port %s", port->name);
2419 if (GetCommModemStatus(port->hdl, &bits) == 0)
2420 RETURN_FAIL("GetCommModemStatus() failed");
2421 if (bits & MS_CTS_ON)
2422 *signals |= SP_SIG_CTS;
2423 if (bits & MS_DSR_ON)
2424 *signals |= SP_SIG_DSR;
2425 if (bits & MS_RLSD_ON)
2426 *signals |= SP_SIG_DCD;
2427 if (bits & MS_RING_ON)
2428 *signals |= SP_SIG_RI;
2431 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2432 RETURN_FAIL("TIOCMGET ioctl failed");
2433 if (bits & TIOCM_CTS)
2434 *signals |= SP_SIG_CTS;
2435 if (bits & TIOCM_DSR)
2436 *signals |= SP_SIG_DSR;
2437 if (bits & TIOCM_CAR)
2438 *signals |= SP_SIG_DCD;
2439 if (bits & TIOCM_RNG)
2440 *signals |= SP_SIG_RI;
2445 SP_API enum sp_return sp_start_break(struct sp_port *port)
2451 if (SetCommBreak(port->hdl) == 0)
2452 RETURN_FAIL("SetCommBreak() failed");
2454 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2455 RETURN_FAIL("TIOCSBRK ioctl failed");
2461 SP_API enum sp_return sp_end_break(struct sp_port *port)
2467 if (ClearCommBreak(port->hdl) == 0)
2468 RETURN_FAIL("ClearCommBreak() failed");
2470 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2471 RETURN_FAIL("TIOCCBRK ioctl failed");
2477 SP_API int sp_last_error_code(void)
2481 RETURN_INT(GetLastError());
2487 SP_API char *sp_last_error_message(void)
2493 DWORD error = GetLastError();
2495 DWORD length = FormatMessageA(
2496 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2497 FORMAT_MESSAGE_FROM_SYSTEM |
2498 FORMAT_MESSAGE_IGNORE_INSERTS,
2501 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2505 if (length >= 2 && message[length - 2] == '\r')
2506 message[length - 2] = '\0';
2508 RETURN_STRING(message);
2510 RETURN_STRING(strerror(errno));
2514 SP_API void sp_free_error_message(char *message)
2516 TRACE("%s", message);
2527 SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...))
2529 TRACE("%p", handler);
2531 sp_debug_handler = handler;
2536 SP_API void sp_default_debug_handler(const char *format, ...)
2539 va_start(args, format);
2540 if (getenv("LIBSERIALPORT_DEBUG")) {
2541 fputs("sp: ", stderr);
2542 vfprintf(stderr, format, args);
2547 SP_API int sp_get_major_package_version(void)
2549 return SP_PACKAGE_VERSION_MAJOR;
2552 SP_API int sp_get_minor_package_version(void)
2554 return SP_PACKAGE_VERSION_MINOR;
2557 SP_API int sp_get_micro_package_version(void)
2559 return SP_PACKAGE_VERSION_MICRO;
2562 SP_API const char *sp_get_package_version_string(void)
2564 return SP_PACKAGE_VERSION_STRING;
2567 SP_API int sp_get_current_lib_version(void)
2569 return SP_LIB_VERSION_CURRENT;
2572 SP_API int sp_get_revision_lib_version(void)
2574 return SP_LIB_VERSION_REVISION;
2577 SP_API int sp_get_age_lib_version(void)
2579 return SP_LIB_VERSION_AGE;
2582 SP_API const char *sp_get_lib_version_string(void)
2584 return SP_LIB_VERSION_STRING;