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/>.
25 #include "libserialport.h"
26 #include "libserialport_internal.h"
28 static const struct std_baudrate std_baudrates[] = {
31 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
32 * have documented CBR_* macros.
34 BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
35 BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
36 BAUD(115200), BAUD(128000), BAUD(256000),
38 BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
39 BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
40 BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
42 #if !defined(__APPLE__) && !defined(__OpenBSD__)
48 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
50 void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
52 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
53 struct sp_port_config *config);
55 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
56 const struct sp_port_config *config);
58 SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
61 #ifndef NO_PORT_METADATA
66 TRACE("%s, %p", portname, port_ptr);
69 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
74 RETURN_ERROR(SP_ERR_ARG, "Null port name");
76 DEBUG_FMT("Building structure for port %s", portname);
78 if (!(port = malloc(sizeof(struct sp_port))))
79 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
81 len = strlen(portname) + 1;
83 if (!(port->name = malloc(len))) {
85 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
88 memcpy(port->name, portname, len);
91 port->usb_path = NULL;
92 port->hdl = INVALID_HANDLE_VALUE;
97 port->description = NULL;
98 port->transport = SP_TRANSPORT_NATIVE;
100 port->usb_address = -1;
103 port->usb_manufacturer = NULL;
104 port->usb_product = NULL;
105 port->usb_serial = NULL;
106 port->bluetooth_address = NULL;
108 #ifndef NO_PORT_METADATA
109 if ((ret = get_port_details(port)) != SP_OK) {
120 SP_API char *sp_get_port_name(const struct sp_port *port)
127 RETURN_STRING(port->name);
130 SP_API char *sp_get_port_description(const struct sp_port *port)
134 if (!port || !port->description)
137 RETURN_STRING(port->description);
140 SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port)
145 RETURN_ERROR(SP_ERR_ARG, "Null port");
147 RETURN_INT(port->transport);
150 SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
151 int *usb_bus,int *usb_address)
156 RETURN_ERROR(SP_ERR_ARG, "Null port");
157 if (port->transport != SP_TRANSPORT_USB)
158 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
159 if (port->usb_bus < 0 || port->usb_address < 0)
160 RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available");
163 *usb_bus = port->usb_bus;
165 *usb_address = port->usb_address;
170 SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
171 int *usb_vid, int *usb_pid)
176 RETURN_ERROR(SP_ERR_ARG, "Null port");
177 if (port->transport != SP_TRANSPORT_USB)
178 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
179 if (port->usb_vid < 0 || port->usb_pid < 0)
180 RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available");
183 *usb_vid = port->usb_vid;
185 *usb_pid = port->usb_pid;
190 SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port)
194 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
197 RETURN_STRING(port->usb_manufacturer);
200 SP_API char *sp_get_port_usb_product(const struct sp_port *port)
204 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
207 RETURN_STRING(port->usb_product);
210 SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
214 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
217 RETURN_STRING(port->usb_serial);
220 SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
224 if (!port || port->transport != SP_TRANSPORT_BLUETOOTH
225 || !port->bluetooth_address)
228 RETURN_STRING(port->bluetooth_address);
231 SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
234 TRACE("%p, %p", port, result_ptr);
237 RETURN_ERROR(SP_ERR_ARG, "Null port");
239 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
242 HANDLE *handle_ptr = result_ptr;
243 *handle_ptr = port->hdl;
245 int *fd_ptr = result_ptr;
252 SP_API enum sp_return sp_copy_port(const struct sp_port *port,
253 struct sp_port **copy_ptr)
255 TRACE("%p, %p", port, copy_ptr);
258 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
263 RETURN_ERROR(SP_ERR_ARG, "Null port");
266 RETURN_ERROR(SP_ERR_ARG, "Null port name");
268 DEBUG("Copying port structure");
270 RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
273 SP_API void sp_free_port(struct sp_port *port)
282 DEBUG("Freeing port structure");
286 if (port->description)
287 free(port->description);
288 if (port->usb_manufacturer)
289 free(port->usb_manufacturer);
290 if (port->usb_product)
291 free(port->usb_product);
292 if (port->usb_serial)
293 free(port->usb_serial);
294 if (port->bluetooth_address)
295 free(port->bluetooth_address);
298 free(port->usb_path);
306 SP_PRIV struct sp_port **list_append(struct sp_port **list,
307 const char *portname)
312 for (count = 0; list[count]; count++);
313 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
316 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
318 list[count + 1] = NULL;
322 sp_free_port_list(list);
326 SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr)
328 #ifndef NO_ENUMERATION
329 struct sp_port **list;
333 TRACE("%p", list_ptr);
336 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
340 #ifdef NO_ENUMERATION
341 RETURN_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
343 DEBUG("Enumerating ports");
345 if (!(list = malloc(sizeof(struct sp_port *))))
346 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
350 ret = list_ports(&list);
355 sp_free_port_list(list);
363 SP_API void sp_free_port_list(struct sp_port **list)
374 DEBUG("Freeing port list");
376 for (i = 0; list[i]; i++)
377 sp_free_port(list[i]);
383 #define CHECK_PORT() do { \
385 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
387 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
390 #define CHECK_PORT_HANDLE() do { \
391 if (port->hdl == INVALID_HANDLE_VALUE) \
392 RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
395 #define CHECK_PORT_HANDLE() do { \
397 RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
400 #define CHECK_OPEN_PORT() do { \
402 CHECK_PORT_HANDLE(); \
406 /** To be called after port receive buffer is emptied. */
407 static enum sp_return restart_wait(struct sp_port *port)
411 if (port->wait_running) {
412 /* Check status of running wait operation. */
413 if (GetOverlappedResult(port->hdl, &port->wait_ovl,
414 &wait_result, FALSE)) {
415 DEBUG("Previous wait completed");
416 port->wait_running = FALSE;
417 } else if (GetLastError() == ERROR_IO_INCOMPLETE) {
418 DEBUG("Previous wait still running");
421 RETURN_FAIL("GetOverlappedResult() failed");
425 if (!port->wait_running) {
426 /* Start new wait operation. */
427 if (WaitCommEvent(port->hdl, &port->events,
429 DEBUG("New wait returned, events already pending");
430 } else if (GetLastError() == ERROR_IO_PENDING) {
431 DEBUG("New wait running in background");
432 port->wait_running = TRUE;
434 RETURN_FAIL("WaitCommEvent() failed");
442 SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
444 struct port_data data;
445 struct sp_port_config config;
448 TRACE("%p, 0x%x", port, flags);
452 if (flags > SP_MODE_READ_WRITE)
453 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
455 DEBUG_FMT("Opening port %s", port->name);
458 DWORD desired_access = 0, flags_and_attributes = 0, errors;
459 char *escaped_port_name;
462 /* Prefix port name with '\\.\' to work with ports above COM9. */
463 if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
464 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
465 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
467 /* Map 'flags' to the OS-specific settings. */
468 flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
469 if (flags & SP_MODE_READ)
470 desired_access |= GENERIC_READ;
471 if (flags & SP_MODE_WRITE)
472 desired_access |= GENERIC_WRITE;
474 port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
475 OPEN_EXISTING, flags_and_attributes, 0);
477 free(escaped_port_name);
479 if (port->hdl == INVALID_HANDLE_VALUE)
480 RETURN_FAIL("Port CreateFile() failed");
482 /* All timeouts initially disabled. */
483 port->timeouts.ReadIntervalTimeout = 0;
484 port->timeouts.ReadTotalTimeoutMultiplier = 0;
485 port->timeouts.ReadTotalTimeoutConstant = 0;
486 port->timeouts.WriteTotalTimeoutMultiplier = 0;
487 port->timeouts.WriteTotalTimeoutConstant = 0;
489 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
491 RETURN_FAIL("SetCommTimeouts() failed");
494 /* Prepare OVERLAPPED structures. */
495 #define INIT_OVERLAPPED(ovl) do { \
496 memset(&port->ovl, 0, sizeof(port->ovl)); \
497 port->ovl.hEvent = INVALID_HANDLE_VALUE; \
498 if ((port->ovl.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL)) \
499 == INVALID_HANDLE_VALUE) { \
501 RETURN_FAIL(#ovl "CreateEvent() failed"); \
505 INIT_OVERLAPPED(read_ovl);
506 INIT_OVERLAPPED(write_ovl);
507 INIT_OVERLAPPED(wait_ovl);
509 /* Set event mask for RX and error events. */
510 if (SetCommMask(port->hdl, EV_RXCHAR | EV_ERR) == 0) {
512 RETURN_FAIL("SetCommMask() failed");
515 port->writing = FALSE;
516 port->wait_running = FALSE;
518 ret = restart_wait(port);
525 int flags_local = O_NONBLOCK | O_NOCTTY;
527 /* Map 'flags' to the OS-specific settings. */
528 if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
529 flags_local |= O_RDWR;
530 else if (flags & SP_MODE_READ)
531 flags_local |= O_RDONLY;
532 else if (flags & SP_MODE_WRITE)
533 flags_local |= O_WRONLY;
535 if ((port->fd = open(port->name, flags_local)) < 0)
536 RETURN_FAIL("open() failed");
539 ret = get_config(port, &data, &config);
546 /* Set sane port settings. */
548 data.dcb.fBinary = TRUE;
549 data.dcb.fDsrSensitivity = FALSE;
550 data.dcb.fErrorChar = FALSE;
551 data.dcb.fNull = FALSE;
552 data.dcb.fAbortOnError = FALSE;
554 /* Turn off all fancy termios tricks, give us a raw channel. */
555 data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
557 data.term.c_iflag &= ~IUCLC;
559 data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET);
561 data.term.c_oflag &= ~OLCUC;
564 data.term.c_oflag &= ~NLDLY;
567 data.term.c_oflag &= ~CRDLY;
570 data.term.c_oflag &= ~TABDLY;
573 data.term.c_oflag &= ~BSDLY;
576 data.term.c_oflag &= ~VTDLY;
579 data.term.c_oflag &= ~FFDLY;
582 data.term.c_oflag &= ~OFILL;
584 data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
585 data.term.c_cc[VMIN] = 0;
586 data.term.c_cc[VTIME] = 0;
588 /* Ignore modem status lines; enable receiver; leave control lines alone on close. */
589 data.term.c_cflag |= (CLOCAL | CREAD | HUPCL);
593 if (ClearCommError(port->hdl, &errors, &status) == 0)
594 RETURN_FAIL("ClearCommError() failed");
597 ret = set_config(port, &data, &config);
607 SP_API enum sp_return sp_close(struct sp_port *port)
613 DEBUG_FMT("Closing port %s", port->name);
616 /* Returns non-zero upon success, 0 upon failure. */
617 if (CloseHandle(port->hdl) == 0)
618 RETURN_FAIL("Port CloseHandle() failed");
619 port->hdl = INVALID_HANDLE_VALUE;
621 /* Close event handles for overlapped structures. */
622 #define CLOSE_OVERLAPPED(ovl) do { \
623 if (port->ovl.hEvent != INVALID_HANDLE_VALUE && \
624 CloseHandle(port->ovl.hEvent) == 0) \
625 RETURN_FAIL(# ovl "event CloseHandle() failed"); \
627 CLOSE_OVERLAPPED(read_ovl);
628 CLOSE_OVERLAPPED(write_ovl);
629 CLOSE_OVERLAPPED(wait_ovl);
632 /* Returns 0 upon success, -1 upon failure. */
633 if (close(port->fd) == -1)
634 RETURN_FAIL("close() failed");
641 SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
643 TRACE("%p, 0x%x", port, buffers);
647 if (buffers > SP_BUF_BOTH)
648 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
650 const char *buffer_names[] = {"no", "input", "output", "both"};
652 DEBUG_FMT("Flushing %s buffers on port %s",
653 buffer_names[buffers], port->name);
657 if (buffers & SP_BUF_INPUT)
658 flags |= PURGE_RXCLEAR;
659 if (buffers & SP_BUF_OUTPUT)
660 flags |= PURGE_TXCLEAR;
662 /* Returns non-zero upon success, 0 upon failure. */
663 if (PurgeComm(port->hdl, flags) == 0)
664 RETURN_FAIL("PurgeComm() failed");
666 if (buffers & SP_BUF_INPUT)
667 TRY(restart_wait(port));
670 if (buffers == SP_BUF_BOTH)
672 else if (buffers == SP_BUF_INPUT)
674 else if (buffers == SP_BUF_OUTPUT)
677 /* Returns 0 upon success, -1 upon failure. */
678 if (tcflush(port->fd, flags) < 0)
679 RETURN_FAIL("tcflush() failed");
684 SP_API enum sp_return sp_drain(struct sp_port *port)
690 DEBUG_FMT("Draining port %s", port->name);
693 /* Returns non-zero upon success, 0 upon failure. */
694 if (FlushFileBuffers(port->hdl) == 0)
695 RETURN_FAIL("FlushFileBuffers() failed");
702 result = ioctl(port->fd, TCSBRK, &arg);
704 result = tcdrain(port->fd);
707 if (errno == EINTR) {
708 DEBUG("tcdrain() was interrupted");
711 RETURN_FAIL("tcdrain() failed");
720 SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
721 size_t count, unsigned int timeout_ms)
723 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
728 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
731 DEBUG_FMT("Writing %d bytes to port %s, timeout %d ms",
732 count, port->name, timeout_ms);
734 DEBUG_FMT("Writing %d bytes to port %s, no timeout",
741 DWORD bytes_written = 0;
744 /* Wait for previous non-blocking write to complete, if any. */
746 DEBUG("Waiting for previous write to complete");
747 result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
750 RETURN_FAIL("Previous write failed to complete");
751 DEBUG("Previous write completed");
755 if (port->timeouts.WriteTotalTimeoutConstant != timeout_ms) {
756 port->timeouts.WriteTotalTimeoutConstant = timeout_ms;
757 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
758 RETURN_FAIL("SetCommTimeouts() failed");
762 if (WriteFile(port->hdl, buf, count, NULL, &port->write_ovl)) {
763 DEBUG("Write completed immediately");
765 } else if (GetLastError() == ERROR_IO_PENDING) {
766 DEBUG("Waiting for write to complete");
767 if (GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE) == 0)
768 RETURN_FAIL("GetOverlappedResult() failed");
769 DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, count);
770 RETURN_INT(bytes_written);
772 RETURN_FAIL("WriteFile() failed");
775 size_t bytes_written = 0;
776 unsigned char *ptr = (unsigned char *) buf;
777 struct timeval start, delta, now, end = {0, 0};
783 /* Get time at start of operation. */
784 gettimeofday(&start, NULL);
785 /* Define duration of timeout. */
786 delta.tv_sec = timeout_ms / 1000;
787 delta.tv_usec = (timeout_ms % 1000) * 1000;
788 /* Calculate time at which we should give up. */
789 timeradd(&start, &delta, &end);
793 FD_SET(port->fd, &fds);
795 /* Loop until we have written the requested number of bytes. */
796 while (bytes_written < count) {
798 * Check timeout only if we have run select() at least once,
799 * to avoid any issues if a short timeout is reached before
800 * select() is even run.
802 if (timeout_ms && started) {
803 gettimeofday(&now, NULL);
804 if (timercmp(&now, &end, >))
805 /* Timeout has expired. */
807 timersub(&end, &now, &delta);
809 result = select(port->fd + 1, NULL, &fds, NULL, timeout_ms ? &delta : NULL);
812 if (errno == EINTR) {
813 DEBUG("select() call was interrupted, repeating");
816 RETURN_FAIL("select() failed");
818 } else if (result == 0) {
819 /* Timeout has expired. */
824 result = write(port->fd, ptr, count - bytes_written);
828 /* This shouldn't happen because we did a select() first, but handle anyway. */
831 /* This is an actual failure. */
832 RETURN_FAIL("write() failed");
835 bytes_written += result;
839 if (bytes_written < count)
840 DEBUG("Write timed out");
842 RETURN_INT(bytes_written);
846 SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
847 const void *buf, size_t count)
849 TRACE("%p, %p, %d", port, buf, count);
854 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
856 DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
863 BYTE *ptr = (BYTE *) buf;
865 /* Check whether previous write is complete. */
867 if (HasOverlappedIoCompleted(&port->write_ovl)) {
868 DEBUG("Previous write completed");
871 DEBUG("Previous write not complete");
872 /* Can't take a new write until the previous one finishes. */
878 if (port->timeouts.WriteTotalTimeoutConstant != 0) {
879 port->timeouts.WriteTotalTimeoutConstant = 0;
880 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
881 RETURN_FAIL("SetCommTimeouts() failed");
885 * Keep writing data until the OS has to actually start an async IO
886 * for it. At that point we know the buffer is full.
888 while (written < count) {
889 /* Copy first byte of user buffer. */
890 port->pending_byte = *ptr++;
892 /* Start asynchronous write. */
893 if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) {
894 if (GetLastError() == ERROR_IO_PENDING) {
895 if (HasOverlappedIoCompleted(&port->write_ovl)) {
896 DEBUG("Asynchronous write completed immediately");
901 DEBUG("Asynchronous write running");
903 RETURN_INT(++written);
906 /* Actual failure of some kind. */
907 RETURN_FAIL("WriteFile() failed");
910 DEBUG("Single byte written immediately");
915 DEBUG("All bytes written immediately");
919 /* Returns the number of bytes written, or -1 upon failure. */
920 ssize_t written = write(port->fd, buf, count);
923 RETURN_FAIL("write() failed");
930 /* Restart wait operation if buffer was emptied. */
931 static enum sp_return restart_wait_if_needed(struct sp_port *port, unsigned int bytes_read)
939 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
940 RETURN_FAIL("ClearCommError() failed");
942 if (comstat.cbInQue == 0)
943 TRY(restart_wait(port));
949 SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
950 size_t count, unsigned int timeout_ms)
952 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
957 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
960 DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms",
961 count, port->name, timeout_ms);
963 DEBUG_FMT("Reading %d bytes from port %s, no timeout",
970 DWORD bytes_read = 0;
973 if (port->timeouts.ReadIntervalTimeout != 0 ||
974 port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
975 port->timeouts.ReadTotalTimeoutConstant != timeout_ms) {
976 port->timeouts.ReadIntervalTimeout = 0;
977 port->timeouts.ReadTotalTimeoutMultiplier = 0;
978 port->timeouts.ReadTotalTimeoutConstant = timeout_ms;
979 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
980 RETURN_FAIL("SetCommTimeouts() failed");
984 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl)) {
985 DEBUG("Read completed immediately");
987 } else if (GetLastError() == ERROR_IO_PENDING) {
988 DEBUG("Waiting for read to complete");
989 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
990 RETURN_FAIL("GetOverlappedResult() failed");
991 DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
993 RETURN_FAIL("ReadFile() failed");
996 TRY(restart_wait_if_needed(port, bytes_read));
998 RETURN_INT(bytes_read);
1001 size_t bytes_read = 0;
1002 unsigned char *ptr = (unsigned char *) buf;
1003 struct timeval start, delta, now, end = {0, 0};
1009 /* Get time at start of operation. */
1010 gettimeofday(&start, NULL);
1011 /* Define duration of timeout. */
1012 delta.tv_sec = timeout_ms / 1000;
1013 delta.tv_usec = (timeout_ms % 1000) * 1000;
1014 /* Calculate time at which we should give up. */
1015 timeradd(&start, &delta, &end);
1019 FD_SET(port->fd, &fds);
1021 /* Loop until we have the requested number of bytes. */
1022 while (bytes_read < count) {
1024 * Check timeout only if we have run select() at least once,
1025 * to avoid any issues if a short timeout is reached before
1026 * select() is even run.
1028 if (timeout_ms && started) {
1029 gettimeofday(&now, NULL);
1030 if (timercmp(&now, &end, >))
1031 /* Timeout has expired. */
1033 timersub(&end, &now, &delta);
1035 result = select(port->fd + 1, &fds, NULL, NULL, timeout_ms ? &delta : NULL);
1038 if (errno == EINTR) {
1039 DEBUG("select() call was interrupted, repeating");
1042 RETURN_FAIL("select() failed");
1044 } else if (result == 0) {
1045 /* Timeout has expired. */
1050 result = read(port->fd, ptr, count - bytes_read);
1053 if (errno == EAGAIN)
1055 * This shouldn't happen because we did a
1056 * select() first, but handle anyway.
1060 /* This is an actual failure. */
1061 RETURN_FAIL("read() failed");
1064 bytes_read += result;
1068 if (bytes_read < count)
1069 DEBUG("Read timed out");
1071 RETURN_INT(bytes_read);
1075 SP_API enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf,
1076 size_t count, unsigned int timeout_ms)
1078 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
1083 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1086 RETURN_ERROR(SP_ERR_ARG, "Zero count");
1089 DEBUG_FMT("Reading next max %d bytes from port %s, timeout %d ms",
1090 count, port->name, timeout_ms);
1092 DEBUG_FMT("Reading next max %d bytes from port %s, no timeout",
1096 DWORD bytes_read = 0;
1098 /* If timeout_ms == 0, set maximum timeout. */
1099 DWORD timeout_val = (timeout_ms == 0 ? MAXDWORD - 1 : timeout_ms);
1102 if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1103 port->timeouts.ReadTotalTimeoutMultiplier != MAXDWORD ||
1104 port->timeouts.ReadTotalTimeoutConstant != timeout_val) {
1105 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1106 port->timeouts.ReadTotalTimeoutMultiplier = MAXDWORD;
1107 port->timeouts.ReadTotalTimeoutConstant = timeout_val;
1108 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1109 RETURN_FAIL("SetCommTimeouts() failed");
1112 /* Loop until we have at least one byte, or timeout is reached. */
1113 while (bytes_read == 0) {
1115 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl)) {
1116 DEBUG("Read completed immediately");
1118 } else if (GetLastError() == ERROR_IO_PENDING) {
1119 DEBUG("Waiting for read to complete");
1120 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1121 RETURN_FAIL("GetOverlappedResult() failed");
1122 if (bytes_read > 0) {
1123 DEBUG("Read completed");
1124 } else if (timeout_ms > 0) {
1125 DEBUG("Read timed out");
1128 DEBUG("Restarting read");
1131 RETURN_FAIL("ReadFile() failed");
1135 TRY(restart_wait_if_needed(port, bytes_read));
1137 RETURN_INT(bytes_read);
1140 size_t bytes_read = 0;
1141 struct timeval start, delta, now, end = {0, 0};
1147 /* Get time at start of operation. */
1148 gettimeofday(&start, NULL);
1149 /* Define duration of timeout. */
1150 delta.tv_sec = timeout_ms / 1000;
1151 delta.tv_usec = (timeout_ms % 1000) * 1000;
1152 /* Calculate time at which we should give up. */
1153 timeradd(&start, &delta, &end);
1157 FD_SET(port->fd, &fds);
1159 /* Loop until we have at least one byte, or timeout is reached. */
1160 while (bytes_read == 0) {
1162 * Check timeout only if we have run select() at least once,
1163 * to avoid any issues if a short timeout is reached before
1164 * select() is even run.
1166 if (timeout_ms && started) {
1167 gettimeofday(&now, NULL);
1168 if (timercmp(&now, &end, >))
1169 /* Timeout has expired. */
1171 timersub(&end, &now, &delta);
1173 result = select(port->fd + 1, &fds, NULL, NULL, timeout_ms ? &delta : NULL);
1176 if (errno == EINTR) {
1177 DEBUG("select() call was interrupted, repeating");
1180 RETURN_FAIL("select() failed");
1182 } else if (result == 0) {
1183 /* Timeout has expired. */
1188 result = read(port->fd, buf, count);
1191 if (errno == EAGAIN)
1192 /* This shouldn't happen because we did a select() first, but handle anyway. */
1195 /* This is an actual failure. */
1196 RETURN_FAIL("read() failed");
1199 bytes_read = result;
1202 if (bytes_read == 0)
1203 DEBUG("Read timed out");
1205 RETURN_INT(bytes_read);
1209 SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
1212 TRACE("%p, %p, %d", port, buf, count);
1217 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1219 DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
1225 if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1226 port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
1227 port->timeouts.ReadTotalTimeoutConstant != 0) {
1228 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1229 port->timeouts.ReadTotalTimeoutMultiplier = 0;
1230 port->timeouts.ReadTotalTimeoutConstant = 0;
1231 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1232 RETURN_FAIL("SetCommTimeouts() failed");
1236 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
1237 if (GetLastError() != ERROR_IO_PENDING)
1238 RETURN_FAIL("ReadFile() failed");
1240 /* Get number of bytes read. */
1241 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, FALSE) == 0)
1242 RETURN_FAIL("GetOverlappedResult() failed");
1244 TRY(restart_wait_if_needed(port, bytes_read));
1246 RETURN_INT(bytes_read);
1250 /* Returns the number of bytes read, or -1 upon failure. */
1251 if ((bytes_read = read(port->fd, buf, count)) < 0) {
1252 if (errno == EAGAIN)
1253 /* No bytes available. */
1256 /* This is an actual failure. */
1257 RETURN_FAIL("read() failed");
1259 RETURN_INT(bytes_read);
1263 SP_API enum sp_return sp_input_waiting(struct sp_port *port)
1269 DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
1275 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1276 RETURN_FAIL("ClearCommError() failed");
1277 RETURN_INT(comstat.cbInQue);
1280 if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1281 RETURN_FAIL("TIOCINQ ioctl failed");
1282 RETURN_INT(bytes_waiting);
1286 SP_API enum sp_return sp_output_waiting(struct sp_port *port)
1292 DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
1298 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1299 RETURN_FAIL("ClearCommError() failed");
1300 RETURN_INT(comstat.cbOutQue);
1303 if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1304 RETURN_FAIL("TIOCOUTQ ioctl failed");
1305 RETURN_INT(bytes_waiting);
1309 SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
1311 struct sp_event_set *result;
1313 TRACE("%p", result_ptr);
1316 RETURN_ERROR(SP_ERR_ARG, "Null result");
1320 if (!(result = malloc(sizeof(struct sp_event_set))))
1321 RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
1323 memset(result, 0, sizeof(struct sp_event_set));
1325 *result_ptr = result;
1330 static enum sp_return add_handle(struct sp_event_set *event_set,
1331 event_handle handle, enum sp_event mask)
1334 enum sp_event *new_masks;
1336 TRACE("%p, %d, %d", event_set, handle, mask);
1338 if (!(new_handles = realloc(event_set->handles,
1339 sizeof(event_handle) * (event_set->count + 1))))
1340 RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed");
1342 event_set->handles = new_handles;
1344 if (!(new_masks = realloc(event_set->masks,
1345 sizeof(enum sp_event) * (event_set->count + 1))))
1346 RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed");
1348 event_set->masks = new_masks;
1350 ((event_handle *) event_set->handles)[event_set->count] = handle;
1351 event_set->masks[event_set->count] = mask;
1358 SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1359 const struct sp_port *port, enum sp_event mask)
1361 TRACE("%p, %p, %d", event_set, port, mask);
1364 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1367 RETURN_ERROR(SP_ERR_ARG, "Null port");
1369 if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
1370 RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
1376 enum sp_event handle_mask;
1377 if ((handle_mask = mask & SP_EVENT_TX_READY))
1378 TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
1379 if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
1380 TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
1382 TRY(add_handle(event_set, port->fd, mask));
1388 SP_API void sp_free_event_set(struct sp_event_set *event_set)
1390 TRACE("%p", event_set);
1393 DEBUG("Null event set");
1397 DEBUG("Freeing event set");
1399 if (event_set->handles)
1400 free(event_set->handles);
1401 if (event_set->masks)
1402 free(event_set->masks);
1409 SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
1410 unsigned int timeout_ms)
1412 TRACE("%p, %d", event_set, timeout_ms);
1415 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1418 if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
1419 timeout_ms ? timeout_ms : INFINITE) == WAIT_FAILED)
1420 RETURN_FAIL("WaitForMultipleObjects() failed");
1424 struct timeval start, delta, now, end = {0, 0};
1425 const struct timeval max_delta = {
1426 (INT_MAX / 1000), (INT_MAX % 1000) * 1000};
1427 int started = 0, timeout_overflow = 0;
1428 int result, timeout_remaining_ms;
1429 struct pollfd *pollfds;
1432 if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
1433 RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
1435 for (i = 0; i < event_set->count; i++) {
1436 pollfds[i].fd = ((int *) event_set->handles)[i];
1437 pollfds[i].events = 0;
1438 pollfds[i].revents = 0;
1439 if (event_set->masks[i] & SP_EVENT_RX_READY)
1440 pollfds[i].events |= POLLIN;
1441 if (event_set->masks[i] & SP_EVENT_TX_READY)
1442 pollfds[i].events |= POLLOUT;
1443 if (event_set->masks[i] & SP_EVENT_ERROR)
1444 pollfds[i].events |= POLLERR;
1448 /* Get time at start of operation. */
1449 gettimeofday(&start, NULL);
1450 /* Define duration of timeout. */
1451 delta.tv_sec = timeout_ms / 1000;
1452 delta.tv_usec = (timeout_ms % 1000) * 1000;
1453 /* Calculate time at which we should give up. */
1454 timeradd(&start, &delta, &end);
1457 /* Loop until an event occurs. */
1460 * Check timeout only if we have run poll() at least once,
1461 * to avoid any issues if a short timeout is reached before
1462 * poll() is even run.
1465 timeout_remaining_ms = -1;
1466 } else if (!started) {
1467 timeout_overflow = (timeout_ms > INT_MAX);
1468 timeout_remaining_ms = timeout_overflow ? INT_MAX : timeout_ms;
1470 gettimeofday(&now, NULL);
1471 if (timercmp(&now, &end, >)) {
1472 DEBUG("Wait timed out");
1475 timersub(&end, &now, &delta);
1476 if ((timeout_overflow = timercmp(&delta, &max_delta, >)))
1478 timeout_remaining_ms = delta.tv_sec * 1000 + delta.tv_usec / 1000;
1481 result = poll(pollfds, event_set->count, timeout_remaining_ms);
1485 if (errno == EINTR) {
1486 DEBUG("poll() call was interrupted, repeating");
1490 RETURN_FAIL("poll() failed");
1492 } else if (result == 0) {
1493 DEBUG("poll() timed out");
1494 if (!timeout_overflow)
1497 DEBUG("poll() completed");
1507 #ifdef USE_TERMIOS_SPEED
1508 static enum sp_return get_baudrate(int fd, int *baudrate)
1512 TRACE("%d, %p", fd, baudrate);
1514 DEBUG("Getting baud rate");
1516 if (!(data = malloc(get_termios_size())))
1517 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1519 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1521 RETURN_FAIL("Getting termios failed");
1524 *baudrate = get_termios_speed(data);
1531 static enum sp_return set_baudrate(int fd, int baudrate)
1535 TRACE("%d, %d", fd, baudrate);
1537 DEBUG("Getting baud rate");
1539 if (!(data = malloc(get_termios_size())))
1540 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1542 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1544 RETURN_FAIL("Getting termios failed");
1547 DEBUG("Setting baud rate");
1549 set_termios_speed(data, baudrate);
1551 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1553 RETURN_FAIL("Setting termios failed");
1560 #endif /* USE_TERMIOS_SPEED */
1563 static enum sp_return get_flow(int fd, struct port_data *data)
1567 TRACE("%d, %p", fd, data);
1569 DEBUG("Getting advanced flow control");
1571 if (!(termx = malloc(get_termiox_size())))
1572 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1574 if (ioctl(fd, TCGETX, termx) < 0) {
1576 RETURN_FAIL("Getting termiox failed");
1579 get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
1580 &data->dtr_flow, &data->dsr_flow);
1587 static enum sp_return set_flow(int fd, struct port_data *data)
1591 TRACE("%d, %p", fd, data);
1593 DEBUG("Getting advanced flow control");
1595 if (!(termx = malloc(get_termiox_size())))
1596 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1598 if (ioctl(fd, TCGETX, termx) < 0) {
1600 RETURN_FAIL("Getting termiox failed");
1603 DEBUG("Setting advanced flow control");
1605 set_termiox_flow(termx, data->rts_flow, data->cts_flow,
1606 data->dtr_flow, data->dsr_flow);
1608 if (ioctl(fd, TCSETX, termx) < 0) {
1610 RETURN_FAIL("Setting termiox failed");
1617 #endif /* USE_TERMIOX */
1619 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1620 struct sp_port_config *config)
1624 TRACE("%p, %p, %p", port, data, config);
1626 DEBUG_FMT("Getting configuration for port %s", port->name);
1629 if (!GetCommState(port->hdl, &data->dcb))
1630 RETURN_FAIL("GetCommState() failed");
1632 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1633 if (data->dcb.BaudRate == std_baudrates[i].index) {
1634 config->baudrate = std_baudrates[i].value;
1639 if (i == NUM_STD_BAUDRATES)
1640 /* BaudRate field can be either an index or a custom baud rate. */
1641 config->baudrate = data->dcb.BaudRate;
1643 config->bits = data->dcb.ByteSize;
1645 if (data->dcb.fParity)
1646 switch (data->dcb.Parity) {
1648 config->parity = SP_PARITY_NONE;
1651 config->parity = SP_PARITY_ODD;
1654 config->parity = SP_PARITY_EVEN;
1657 config->parity = SP_PARITY_MARK;
1660 config->parity = SP_PARITY_SPACE;
1663 config->parity = -1;
1666 config->parity = SP_PARITY_NONE;
1668 switch (data->dcb.StopBits) {
1670 config->stopbits = 1;
1673 config->stopbits = 2;
1676 config->stopbits = -1;
1679 switch (data->dcb.fRtsControl) {
1680 case RTS_CONTROL_DISABLE:
1681 config->rts = SP_RTS_OFF;
1683 case RTS_CONTROL_ENABLE:
1684 config->rts = SP_RTS_ON;
1686 case RTS_CONTROL_HANDSHAKE:
1687 config->rts = SP_RTS_FLOW_CONTROL;
1693 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1695 switch (data->dcb.fDtrControl) {
1696 case DTR_CONTROL_DISABLE:
1697 config->dtr = SP_DTR_OFF;
1699 case DTR_CONTROL_ENABLE:
1700 config->dtr = SP_DTR_ON;
1702 case DTR_CONTROL_HANDSHAKE:
1703 config->dtr = SP_DTR_FLOW_CONTROL;
1709 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1711 if (data->dcb.fInX) {
1712 if (data->dcb.fOutX)
1713 config->xon_xoff = SP_XONXOFF_INOUT;
1715 config->xon_xoff = SP_XONXOFF_IN;
1717 if (data->dcb.fOutX)
1718 config->xon_xoff = SP_XONXOFF_OUT;
1720 config->xon_xoff = SP_XONXOFF_DISABLED;
1725 if (tcgetattr(port->fd, &data->term) < 0)
1726 RETURN_FAIL("tcgetattr() failed");
1728 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1729 RETURN_FAIL("TIOCMGET ioctl failed");
1732 int ret = get_flow(port->fd, data);
1734 if (ret == SP_ERR_FAIL && errno == EINVAL)
1735 data->termiox_supported = 0;
1737 RETURN_CODEVAL(ret);
1739 data->termiox_supported = 1;
1741 data->termiox_supported = 0;
1744 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1745 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1746 config->baudrate = std_baudrates[i].value;
1751 if (i == NUM_STD_BAUDRATES) {
1753 config->baudrate = (int)data->term.c_ispeed;
1754 #elif defined(USE_TERMIOS_SPEED)
1755 TRY(get_baudrate(port->fd, &config->baudrate));
1757 config->baudrate = -1;
1761 switch (data->term.c_cflag & CSIZE) {
1778 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1779 config->parity = SP_PARITY_NONE;
1780 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1781 config->parity = -1;
1783 else if (data->term.c_cflag & CMSPAR)
1784 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1787 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1789 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1791 if (data->term.c_cflag & CRTSCTS) {
1792 config->rts = SP_RTS_FLOW_CONTROL;
1793 config->cts = SP_CTS_FLOW_CONTROL;
1795 if (data->termiox_supported && data->rts_flow)
1796 config->rts = SP_RTS_FLOW_CONTROL;
1798 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1800 config->cts = (data->termiox_supported && data->cts_flow) ?
1801 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1804 if (data->termiox_supported && data->dtr_flow)
1805 config->dtr = SP_DTR_FLOW_CONTROL;
1807 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1809 config->dsr = (data->termiox_supported && data->dsr_flow) ?
1810 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1812 if (data->term.c_iflag & IXOFF) {
1813 if (data->term.c_iflag & IXON)
1814 config->xon_xoff = SP_XONXOFF_INOUT;
1816 config->xon_xoff = SP_XONXOFF_IN;
1818 if (data->term.c_iflag & IXON)
1819 config->xon_xoff = SP_XONXOFF_OUT;
1821 config->xon_xoff = SP_XONXOFF_DISABLED;
1828 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1829 const struct sp_port_config *config)
1833 BAUD_TYPE baud_nonstd;
1837 #ifdef USE_TERMIOS_SPEED
1838 int baud_nonstd = 0;
1841 TRACE("%p, %p, %p", port, data, config);
1843 DEBUG_FMT("Setting configuration for port %s", port->name);
1846 if (config->baudrate >= 0) {
1847 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1848 if (config->baudrate == std_baudrates[i].value) {
1849 data->dcb.BaudRate = std_baudrates[i].index;
1854 if (i == NUM_STD_BAUDRATES)
1855 data->dcb.BaudRate = config->baudrate;
1858 if (config->bits >= 0)
1859 data->dcb.ByteSize = config->bits;
1861 if (config->parity >= 0) {
1862 switch (config->parity) {
1863 case SP_PARITY_NONE:
1864 data->dcb.Parity = NOPARITY;
1867 data->dcb.Parity = ODDPARITY;
1869 case SP_PARITY_EVEN:
1870 data->dcb.Parity = EVENPARITY;
1872 case SP_PARITY_MARK:
1873 data->dcb.Parity = MARKPARITY;
1875 case SP_PARITY_SPACE:
1876 data->dcb.Parity = SPACEPARITY;
1879 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1883 if (config->stopbits >= 0) {
1884 switch (config->stopbits) {
1885 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1887 data->dcb.StopBits = ONESTOPBIT;
1890 data->dcb.StopBits = TWOSTOPBITS;
1893 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1897 if (config->rts >= 0) {
1898 switch (config->rts) {
1900 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1903 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1905 case SP_RTS_FLOW_CONTROL:
1906 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1909 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1913 if (config->cts >= 0) {
1914 switch (config->cts) {
1916 data->dcb.fOutxCtsFlow = FALSE;
1918 case SP_CTS_FLOW_CONTROL:
1919 data->dcb.fOutxCtsFlow = TRUE;
1922 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1926 if (config->dtr >= 0) {
1927 switch (config->dtr) {
1929 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1932 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1934 case SP_DTR_FLOW_CONTROL:
1935 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1938 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1942 if (config->dsr >= 0) {
1943 switch (config->dsr) {
1945 data->dcb.fOutxDsrFlow = FALSE;
1947 case SP_DSR_FLOW_CONTROL:
1948 data->dcb.fOutxDsrFlow = TRUE;
1951 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1955 if (config->xon_xoff >= 0) {
1956 switch (config->xon_xoff) {
1957 case SP_XONXOFF_DISABLED:
1958 data->dcb.fInX = FALSE;
1959 data->dcb.fOutX = FALSE;
1962 data->dcb.fInX = TRUE;
1963 data->dcb.fOutX = FALSE;
1965 case SP_XONXOFF_OUT:
1966 data->dcb.fInX = FALSE;
1967 data->dcb.fOutX = TRUE;
1969 case SP_XONXOFF_INOUT:
1970 data->dcb.fInX = TRUE;
1971 data->dcb.fOutX = TRUE;
1974 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1978 if (!SetCommState(port->hdl, &data->dcb))
1979 RETURN_FAIL("SetCommState() failed");
1985 if (config->baudrate >= 0) {
1986 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1987 if (config->baudrate == std_baudrates[i].value) {
1988 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1989 RETURN_FAIL("cfsetospeed() failed");
1991 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1992 RETURN_FAIL("cfsetispeed() failed");
1997 /* Non-standard baud rate */
1998 if (i == NUM_STD_BAUDRATES) {
2000 /* Set "dummy" baud rate. */
2001 if (cfsetspeed(&data->term, B9600) < 0)
2002 RETURN_FAIL("cfsetspeed() failed");
2003 baud_nonstd = config->baudrate;
2004 #elif defined(USE_TERMIOS_SPEED)
2007 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
2012 if (config->bits >= 0) {
2013 data->term.c_cflag &= ~CSIZE;
2014 switch (config->bits) {
2016 data->term.c_cflag |= CS8;
2019 data->term.c_cflag |= CS7;
2022 data->term.c_cflag |= CS6;
2025 data->term.c_cflag |= CS5;
2028 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
2032 if (config->parity >= 0) {
2033 data->term.c_iflag &= ~IGNPAR;
2034 data->term.c_cflag &= ~(PARENB | PARODD);
2036 data->term.c_cflag &= ~CMSPAR;
2038 switch (config->parity) {
2039 case SP_PARITY_NONE:
2040 data->term.c_iflag |= IGNPAR;
2042 case SP_PARITY_EVEN:
2043 data->term.c_cflag |= PARENB;
2046 data->term.c_cflag |= PARENB | PARODD;
2049 case SP_PARITY_MARK:
2050 data->term.c_cflag |= PARENB | PARODD;
2051 data->term.c_cflag |= CMSPAR;
2053 case SP_PARITY_SPACE:
2054 data->term.c_cflag |= PARENB;
2055 data->term.c_cflag |= CMSPAR;
2058 case SP_PARITY_MARK:
2059 case SP_PARITY_SPACE:
2060 RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
2063 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
2067 if (config->stopbits >= 0) {
2068 data->term.c_cflag &= ~CSTOPB;
2069 switch (config->stopbits) {
2071 data->term.c_cflag &= ~CSTOPB;
2074 data->term.c_cflag |= CSTOPB;
2077 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
2081 if (config->rts >= 0 || config->cts >= 0) {
2082 if (data->termiox_supported) {
2083 data->rts_flow = data->cts_flow = 0;
2084 switch (config->rts) {
2087 controlbits = TIOCM_RTS;
2088 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
2089 RETURN_FAIL("Setting RTS signal level failed");
2091 case SP_RTS_FLOW_CONTROL:
2097 if (config->cts == SP_CTS_FLOW_CONTROL)
2100 if (data->rts_flow && data->cts_flow)
2101 data->term.c_iflag |= CRTSCTS;
2103 data->term.c_iflag &= ~CRTSCTS;
2105 /* Asymmetric use of RTS/CTS not supported. */
2106 if (data->term.c_iflag & CRTSCTS) {
2107 /* Flow control can only be disabled for both RTS & CTS together. */
2108 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
2109 if (config->cts != SP_CTS_IGNORE)
2110 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
2112 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
2113 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
2114 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
2117 /* Flow control can only be enabled for both RTS & CTS together. */
2118 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
2119 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
2120 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
2123 if (config->rts >= 0) {
2124 if (config->rts == SP_RTS_FLOW_CONTROL) {
2125 data->term.c_iflag |= CRTSCTS;
2127 controlbits = TIOCM_RTS;
2128 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
2130 RETURN_FAIL("Setting RTS signal level failed");
2136 if (config->dtr >= 0 || config->dsr >= 0) {
2137 if (data->termiox_supported) {
2138 data->dtr_flow = data->dsr_flow = 0;
2139 switch (config->dtr) {
2142 controlbits = TIOCM_DTR;
2143 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
2144 RETURN_FAIL("Setting DTR signal level failed");
2146 case SP_DTR_FLOW_CONTROL:
2152 if (config->dsr == SP_DSR_FLOW_CONTROL)
2155 /* DTR/DSR flow control not supported. */
2156 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
2157 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
2159 if (config->dtr >= 0) {
2160 controlbits = TIOCM_DTR;
2161 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
2163 RETURN_FAIL("Setting DTR signal level failed");
2168 if (config->xon_xoff >= 0) {
2169 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
2170 switch (config->xon_xoff) {
2171 case SP_XONXOFF_DISABLED:
2174 data->term.c_iflag |= IXOFF;
2176 case SP_XONXOFF_OUT:
2177 data->term.c_iflag |= IXON | IXANY;
2179 case SP_XONXOFF_INOUT:
2180 data->term.c_iflag |= IXON | IXOFF | IXANY;
2183 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2187 if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
2188 RETURN_FAIL("tcsetattr() failed");
2191 if (baud_nonstd != B0) {
2192 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
2193 RETURN_FAIL("IOSSIOSPEED ioctl failed");
2195 * Set baud rates in data->term to correct, but incompatible
2196 * with tcsetattr() value, same as delivered by tcgetattr().
2198 if (cfsetspeed(&data->term, baud_nonstd) < 0)
2199 RETURN_FAIL("cfsetspeed() failed");
2201 #elif defined(__linux__)
2202 #ifdef USE_TERMIOS_SPEED
2204 TRY(set_baudrate(port->fd, config->baudrate));
2207 if (data->termiox_supported)
2208 TRY(set_flow(port->fd, data));
2212 #endif /* !_WIN32 */
2217 SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
2219 struct sp_port_config *config;
2221 TRACE("%p", config_ptr);
2224 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2228 if (!(config = malloc(sizeof(struct sp_port_config))))
2229 RETURN_ERROR(SP_ERR_MEM, "Config malloc failed");
2231 config->baudrate = -1;
2233 config->parity = -1;
2234 config->stopbits = -1;
2240 *config_ptr = config;
2245 SP_API void sp_free_config(struct sp_port_config *config)
2247 TRACE("%p", config);
2250 DEBUG("Null config");
2257 SP_API enum sp_return sp_get_config(struct sp_port *port,
2258 struct sp_port_config *config)
2260 struct port_data data;
2262 TRACE("%p, %p", port, config);
2267 RETURN_ERROR(SP_ERR_ARG, "Null config");
2269 TRY(get_config(port, &data, config));
2274 SP_API enum sp_return sp_set_config(struct sp_port *port,
2275 const struct sp_port_config *config)
2277 struct port_data data;
2278 struct sp_port_config prev_config;
2280 TRACE("%p, %p", port, config);
2285 RETURN_ERROR(SP_ERR_ARG, "Null config");
2287 TRY(get_config(port, &data, &prev_config));
2288 TRY(set_config(port, &data, config));
2293 #define CREATE_ACCESSORS(x, type) \
2294 SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2295 struct port_data data; \
2296 struct sp_port_config config; \
2297 TRACE("%p, %d", port, x); \
2298 CHECK_OPEN_PORT(); \
2299 TRY(get_config(port, &data, &config)); \
2301 TRY(set_config(port, &data, &config)); \
2304 SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \
2306 TRACE("%p, %p", config, x); \
2308 RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); \
2310 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2314 SP_API enum sp_return sp_set_config_##x(struct sp_port_config *config, \
2316 TRACE("%p, %d", config, x); \
2318 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2323 CREATE_ACCESSORS(baudrate, int)
2324 CREATE_ACCESSORS(bits, int)
2325 CREATE_ACCESSORS(parity, enum sp_parity)
2326 CREATE_ACCESSORS(stopbits, int)
2327 CREATE_ACCESSORS(rts, enum sp_rts)
2328 CREATE_ACCESSORS(cts, enum sp_cts)
2329 CREATE_ACCESSORS(dtr, enum sp_dtr)
2330 CREATE_ACCESSORS(dsr, enum sp_dsr)
2331 CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2333 SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config,
2334 enum sp_flowcontrol flowcontrol)
2337 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2339 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2340 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2342 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2343 config->xon_xoff = SP_XONXOFF_INOUT;
2345 config->xon_xoff = SP_XONXOFF_DISABLED;
2347 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2348 config->rts = SP_RTS_FLOW_CONTROL;
2349 config->cts = SP_CTS_FLOW_CONTROL;
2351 if (config->rts == SP_RTS_FLOW_CONTROL)
2352 config->rts = SP_RTS_ON;
2353 config->cts = SP_CTS_IGNORE;
2356 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2357 config->dtr = SP_DTR_FLOW_CONTROL;
2358 config->dsr = SP_DSR_FLOW_CONTROL;
2360 if (config->dtr == SP_DTR_FLOW_CONTROL)
2361 config->dtr = SP_DTR_ON;
2362 config->dsr = SP_DSR_IGNORE;
2368 SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port,
2369 enum sp_flowcontrol flowcontrol)
2371 struct port_data data;
2372 struct sp_port_config config;
2374 TRACE("%p, %d", port, flowcontrol);
2378 TRY(get_config(port, &data, &config));
2380 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2382 TRY(set_config(port, &data, &config));
2387 SP_API enum sp_return sp_get_signals(struct sp_port *port,
2388 enum sp_signal *signals)
2390 TRACE("%p, %p", port, signals);
2395 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2397 DEBUG_FMT("Getting control signals for port %s", port->name);
2402 if (GetCommModemStatus(port->hdl, &bits) == 0)
2403 RETURN_FAIL("GetCommModemStatus() failed");
2404 if (bits & MS_CTS_ON)
2405 *signals |= SP_SIG_CTS;
2406 if (bits & MS_DSR_ON)
2407 *signals |= SP_SIG_DSR;
2408 if (bits & MS_RLSD_ON)
2409 *signals |= SP_SIG_DCD;
2410 if (bits & MS_RING_ON)
2411 *signals |= SP_SIG_RI;
2414 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2415 RETURN_FAIL("TIOCMGET ioctl failed");
2416 if (bits & TIOCM_CTS)
2417 *signals |= SP_SIG_CTS;
2418 if (bits & TIOCM_DSR)
2419 *signals |= SP_SIG_DSR;
2420 if (bits & TIOCM_CAR)
2421 *signals |= SP_SIG_DCD;
2422 if (bits & TIOCM_RNG)
2423 *signals |= SP_SIG_RI;
2428 SP_API enum sp_return sp_start_break(struct sp_port *port)
2434 if (SetCommBreak(port->hdl) == 0)
2435 RETURN_FAIL("SetCommBreak() failed");
2437 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2438 RETURN_FAIL("TIOCSBRK ioctl failed");
2444 SP_API enum sp_return sp_end_break(struct sp_port *port)
2450 if (ClearCommBreak(port->hdl) == 0)
2451 RETURN_FAIL("ClearCommBreak() failed");
2453 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2454 RETURN_FAIL("TIOCCBRK ioctl failed");
2460 SP_API int sp_last_error_code(void)
2464 RETURN_INT(GetLastError());
2470 SP_API char *sp_last_error_message(void)
2476 DWORD error = GetLastError();
2478 DWORD length = FormatMessage(
2479 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2480 FORMAT_MESSAGE_FROM_SYSTEM |
2481 FORMAT_MESSAGE_IGNORE_INSERTS,
2484 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2488 if (length >= 2 && message[length - 2] == '\r')
2489 message[length - 2] = '\0';
2491 RETURN_STRING(message);
2493 RETURN_STRING(strerror(errno));
2497 SP_API void sp_free_error_message(char *message)
2499 TRACE("%s", message);
2510 SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...))
2512 TRACE("%p", handler);
2514 sp_debug_handler = handler;
2519 SP_API void sp_default_debug_handler(const char *format, ...)
2522 va_start(args, format);
2523 if (getenv("LIBSERIALPORT_DEBUG")) {
2524 fputs("sp: ", stderr);
2525 vfprintf(stderr, format, args);
2530 SP_API int sp_get_major_package_version(void)
2532 return SP_PACKAGE_VERSION_MAJOR;
2535 SP_API int sp_get_minor_package_version(void)
2537 return SP_PACKAGE_VERSION_MINOR;
2540 SP_API int sp_get_micro_package_version(void)
2542 return SP_PACKAGE_VERSION_MICRO;
2545 SP_API const char *sp_get_package_version_string(void)
2547 return SP_PACKAGE_VERSION_STRING;
2550 SP_API int sp_get_current_lib_version(void)
2552 return SP_LIB_VERSION_CURRENT;
2555 SP_API int sp_get_revision_lib_version(void)
2557 return SP_LIB_VERSION_REVISION;
2560 SP_API int sp_get_age_lib_version(void)
2562 return SP_LIB_VERSION_AGE;
2565 SP_API const char *sp_get_lib_version_string(void)
2567 return SP_LIB_VERSION_STRING;