2 * This file is part of the libserialport project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
6 * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
7 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
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.h"
25 #include "libserialport_internal.h"
27 const struct std_baudrate std_baudrates[] = {
30 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
31 * have documented CBR_* macros.
33 BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
34 BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
35 BAUD(115200), BAUD(128000), BAUD(256000),
37 BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
38 BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
39 BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
41 #if !defined(__APPLE__) && !defined(__OpenBSD__)
47 void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
49 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
50 struct sp_port_config *config);
52 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
53 const struct sp_port_config *config);
55 SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
58 #ifndef NO_PORT_METADATA
63 TRACE("%s, %p", portname, port_ptr);
66 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
71 RETURN_ERROR(SP_ERR_ARG, "Null port name");
73 DEBUG_FMT("Building structure for port %s", portname);
75 if (!(port = malloc(sizeof(struct sp_port))))
76 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
78 len = strlen(portname) + 1;
80 if (!(port->name = malloc(len))) {
82 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
85 memcpy(port->name, portname, len);
88 port->usb_path = NULL;
89 port->hdl = INVALID_HANDLE_VALUE;
94 port->description = NULL;
95 port->transport = SP_TRANSPORT_NATIVE;
97 port->usb_address = -1;
100 port->usb_manufacturer = NULL;
101 port->usb_product = NULL;
102 port->usb_serial = NULL;
103 port->bluetooth_address = NULL;
105 #ifndef NO_PORT_METADATA
106 if ((ret = get_port_details(port)) != SP_OK) {
117 SP_API char *sp_get_port_name(const struct sp_port *port)
124 RETURN_STRING(port->name);
127 SP_API char *sp_get_port_description(struct sp_port *port)
131 if (!port || !port->description)
134 RETURN_STRING(port->description);
137 SP_API enum sp_transport sp_get_port_transport(struct sp_port *port)
142 RETURN_ERROR(SP_ERR_ARG, "Null port");
144 RETURN_INT(port->transport);
147 SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
148 int *usb_bus,int *usb_address)
153 RETURN_ERROR(SP_ERR_ARG, "Null port");
154 if (port->transport != SP_TRANSPORT_USB)
155 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
156 if (port->usb_bus < 0 || port->usb_address < 0)
157 RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available");
159 if (usb_bus) *usb_bus = port->usb_bus;
160 if (usb_address) *usb_address = port->usb_address;
165 SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
166 int *usb_vid, int *usb_pid)
171 RETURN_ERROR(SP_ERR_ARG, "Null port");
172 if (port->transport != SP_TRANSPORT_USB)
173 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
174 if (port->usb_vid < 0 || port->usb_pid < 0)
175 RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available");
177 if (usb_vid) *usb_vid = port->usb_vid;
178 if (usb_pid) *usb_pid = port->usb_pid;
183 SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port)
187 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
190 RETURN_STRING(port->usb_manufacturer);
193 SP_API char *sp_get_port_usb_product(const struct sp_port *port)
197 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
200 RETURN_STRING(port->usb_product);
203 SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
207 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
210 RETURN_STRING(port->usb_serial);
213 SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
217 if (!port || port->transport != SP_TRANSPORT_BLUETOOTH
218 || !port->bluetooth_address)
221 RETURN_STRING(port->bluetooth_address);
224 SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
227 TRACE("%p, %p", port, result_ptr);
230 RETURN_ERROR(SP_ERR_ARG, "Null port");
233 HANDLE *handle_ptr = result_ptr;
234 *handle_ptr = port->hdl;
236 int *fd_ptr = result_ptr;
243 SP_API enum sp_return sp_copy_port(const struct sp_port *port,
244 struct sp_port **copy_ptr)
246 TRACE("%p, %p", port, copy_ptr);
249 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
254 RETURN_ERROR(SP_ERR_ARG, "Null port");
257 RETURN_ERROR(SP_ERR_ARG, "Null port name");
259 DEBUG("Copying port structure");
261 RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
264 SP_API void sp_free_port(struct sp_port *port)
273 DEBUG("Freeing port structure");
277 if (port->description)
278 free(port->description);
279 if (port->usb_manufacturer)
280 free(port->usb_manufacturer);
281 if (port->usb_product)
282 free(port->usb_product);
283 if (port->usb_serial)
284 free(port->usb_serial);
285 if (port->bluetooth_address)
286 free(port->bluetooth_address);
289 free(port->usb_path);
297 SP_PRIV struct sp_port **list_append(struct sp_port **list,
298 const char *portname)
303 for (count = 0; list[count]; count++);
304 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
307 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
309 list[count + 1] = NULL;
313 sp_free_port_list(list);
317 SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr)
319 struct sp_port **list;
322 TRACE("%p", list_ptr);
325 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
327 DEBUG("Enumerating ports");
329 if (!(list = malloc(sizeof(struct sp_port **))))
330 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
334 #ifdef NO_ENUMERATION
337 ret = list_ports(&list);
345 DEBUG_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
348 sp_free_port_list(list);
354 SP_API void sp_free_port_list(struct sp_port **list)
365 DEBUG("Freeing port list");
367 for (i = 0; list[i]; i++)
368 sp_free_port(list[i]);
374 #define CHECK_PORT() do { \
376 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
377 if (port->name == NULL) \
378 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
381 #define CHECK_PORT_HANDLE() do { \
382 if (port->hdl == INVALID_HANDLE_VALUE) \
383 RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
386 #define CHECK_PORT_HANDLE() do { \
388 RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
391 #define CHECK_OPEN_PORT() do { \
393 CHECK_PORT_HANDLE(); \
396 SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
398 struct port_data data;
399 struct sp_port_config config;
402 TRACE("%p, 0x%x", port, flags);
406 if (flags > SP_MODE_READ_WRITE)
407 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
409 DEBUG_FMT("Opening port %s", port->name);
412 DWORD desired_access = 0, flags_and_attributes = 0, errors;
413 char *escaped_port_name;
416 /* Prefix port name with '\\.\' to work with ports above COM9. */
417 if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
418 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
419 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
421 /* Map 'flags' to the OS-specific settings. */
422 flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
423 if (flags & SP_MODE_READ)
424 desired_access |= GENERIC_READ;
425 if (flags & SP_MODE_WRITE)
426 desired_access |= GENERIC_WRITE;
428 port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
429 OPEN_EXISTING, flags_and_attributes, 0);
431 free(escaped_port_name);
433 if (port->hdl == INVALID_HANDLE_VALUE)
434 RETURN_FAIL("port CreateFile() failed");
436 /* All timeouts initially disabled. */
437 port->timeouts.ReadIntervalTimeout = 0;
438 port->timeouts.ReadTotalTimeoutMultiplier = 0;
439 port->timeouts.ReadTotalTimeoutConstant = 0;
440 port->timeouts.WriteTotalTimeoutMultiplier = 0;
441 port->timeouts.WriteTotalTimeoutConstant = 0;
443 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
445 RETURN_FAIL("SetCommTimeouts() failed");
448 /* Prepare OVERLAPPED structures. */
449 #define INIT_OVERLAPPED(ovl) do { \
450 memset(&port->ovl, 0, sizeof(port->ovl)); \
451 port->ovl.hEvent = INVALID_HANDLE_VALUE; \
452 if ((port->ovl.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL)) \
453 == INVALID_HANDLE_VALUE) { \
455 RETURN_FAIL(#ovl "CreateEvent() failed"); \
459 INIT_OVERLAPPED(read_ovl);
460 INIT_OVERLAPPED(write_ovl);
461 INIT_OVERLAPPED(wait_ovl);
463 /* Set event mask for RX and error events. */
464 if (SetCommMask(port->hdl, EV_RXCHAR | EV_ERR) == 0) {
466 RETURN_FAIL("SetCommMask() failed");
469 /* Start background operation for RX and error events. */
470 if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) {
471 if (GetLastError() != ERROR_IO_PENDING) {
473 RETURN_FAIL("WaitCommEvent() failed");
477 port->writing = FALSE;
480 int flags_local = O_NONBLOCK | O_NOCTTY;
482 /* Map 'flags' to the OS-specific settings. */
483 if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
484 flags_local |= O_RDWR;
485 else if (flags & SP_MODE_READ)
486 flags_local |= O_RDONLY;
487 else if (flags & SP_MODE_WRITE)
488 flags_local |= O_WRONLY;
490 if ((port->fd = open(port->name, flags_local)) < 0)
491 RETURN_FAIL("open() failed");
494 ret = get_config(port, &data, &config);
501 /* Set sane port settings. */
503 data.dcb.fBinary = TRUE;
504 data.dcb.fDsrSensitivity = FALSE;
505 data.dcb.fErrorChar = FALSE;
506 data.dcb.fNull = FALSE;
507 data.dcb.fAbortOnError = TRUE;
509 /* Turn off all fancy termios tricks, give us a raw channel. */
510 data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
512 data.term.c_iflag &= ~IUCLC;
514 data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET);
516 data.term.c_oflag &= ~OLCUC;
519 data.term.c_oflag &= ~NLDLY;
522 data.term.c_oflag &= ~CRDLY;
525 data.term.c_oflag &= ~TABDLY;
528 data.term.c_oflag &= ~BSDLY;
531 data.term.c_oflag &= ~VTDLY;
534 data.term.c_oflag &= ~FFDLY;
537 data.term.c_oflag &= ~OFILL;
539 data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
540 data.term.c_cc[VMIN] = 0;
541 data.term.c_cc[VTIME] = 0;
543 /* Ignore modem status lines; enable receiver; leave control lines alone on close. */
544 data.term.c_cflag |= (CLOCAL | CREAD | HUPCL);
548 if (ClearCommError(port->hdl, &errors, &status) == 0)
549 RETURN_FAIL("ClearCommError() failed");
552 ret = set_config(port, &data, &config);
562 SP_API enum sp_return sp_close(struct sp_port *port)
568 DEBUG_FMT("Closing port %s", port->name);
571 /* Returns non-zero upon success, 0 upon failure. */
572 if (CloseHandle(port->hdl) == 0)
573 RETURN_FAIL("port CloseHandle() failed");
574 port->hdl = INVALID_HANDLE_VALUE;
576 /* Close event handles for overlapped structures. */
577 #define CLOSE_OVERLAPPED(ovl) do { \
578 if (port->ovl.hEvent != INVALID_HANDLE_VALUE && \
579 CloseHandle(port->ovl.hEvent) == 0) \
580 RETURN_FAIL(# ovl "event CloseHandle() failed"); \
582 CLOSE_OVERLAPPED(read_ovl);
583 CLOSE_OVERLAPPED(write_ovl);
584 CLOSE_OVERLAPPED(wait_ovl);
587 /* Returns 0 upon success, -1 upon failure. */
588 if (close(port->fd) == -1)
589 RETURN_FAIL("close() failed");
596 SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
598 TRACE("%p, 0x%x", port, buffers);
602 if (buffers > SP_BUF_BOTH)
603 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
605 const char *buffer_names[] = {"no", "input", "output", "both"};
607 DEBUG_FMT("Flushing %s buffers on port %s",
608 buffer_names[buffers], port->name);
612 if (buffers & SP_BUF_INPUT)
613 flags |= PURGE_RXCLEAR;
614 if (buffers & SP_BUF_OUTPUT)
615 flags |= PURGE_TXCLEAR;
617 /* Returns non-zero upon success, 0 upon failure. */
618 if (PurgeComm(port->hdl, flags) == 0)
619 RETURN_FAIL("PurgeComm() failed");
622 if (buffers == SP_BUF_BOTH)
624 else if (buffers == SP_BUF_INPUT)
626 else if (buffers == SP_BUF_OUTPUT)
629 /* Returns 0 upon success, -1 upon failure. */
630 if (tcflush(port->fd, flags) < 0)
631 RETURN_FAIL("tcflush() failed");
636 SP_API enum sp_return sp_drain(struct sp_port *port)
642 DEBUG_FMT("Draining port %s", port->name);
645 /* Returns non-zero upon success, 0 upon failure. */
646 if (FlushFileBuffers(port->hdl) == 0)
647 RETURN_FAIL("FlushFileBuffers() failed");
654 result = ioctl(port->fd, TCSBRK, &arg);
656 result = tcdrain(port->fd);
659 if (errno == EINTR) {
660 DEBUG("tcdrain() was interrupted");
663 RETURN_FAIL("tcdrain() failed");
672 SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
673 size_t count, unsigned int timeout)
675 TRACE("%p, %p, %d, %d", port, buf, count, timeout);
680 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
683 DEBUG_FMT("Writing %d bytes to port %s, timeout %d ms",
684 count, port->name, timeout);
686 DEBUG_FMT("Writing %d bytes to port %s, no timeout",
693 DWORD bytes_written = 0;
696 /* Wait for previous non-blocking write to complete, if any. */
698 DEBUG("Waiting for previous write to complete");
699 result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
702 RETURN_FAIL("Previous write failed to complete");
703 DEBUG("Previous write completed");
707 port->timeouts.WriteTotalTimeoutConstant = timeout;
708 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
709 RETURN_FAIL("SetCommTimeouts() failed");
712 if (WriteFile(port->hdl, buf, count, NULL, &port->write_ovl) == 0) {
713 if (GetLastError() == ERROR_IO_PENDING) {
714 DEBUG("Waiting for write to complete");
715 GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
716 DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, count);
717 RETURN_INT(bytes_written);
719 RETURN_FAIL("WriteFile() failed");
722 DEBUG("Write completed immediately");
726 size_t bytes_written = 0;
727 unsigned char *ptr = (unsigned char *) buf;
728 struct timeval start, delta, now, end = {0, 0};
733 /* Get time at start of operation. */
734 gettimeofday(&start, NULL);
735 /* Define duration of timeout. */
736 delta.tv_sec = timeout / 1000;
737 delta.tv_usec = (timeout % 1000) * 1000;
738 /* Calculate time at which we should give up. */
739 timeradd(&start, &delta, &end);
742 /* Loop until we have written the requested number of bytes. */
743 while (bytes_written < count)
745 /* Wait until space is available. */
747 FD_SET(port->fd, &fds);
749 gettimeofday(&now, NULL);
750 if (timercmp(&now, &end, >)) {
751 DEBUG("write timed out");
752 RETURN_INT(bytes_written);
754 timersub(&end, &now, &delta);
756 result = select(port->fd + 1, NULL, &fds, NULL, timeout ? &delta : NULL);
758 if (errno == EINTR) {
759 DEBUG("select() call was interrupted, repeating");
762 RETURN_FAIL("select() failed");
764 } else if (result == 0) {
765 DEBUG("write timed out");
766 RETURN_INT(bytes_written);
770 result = write(port->fd, ptr, count - bytes_written);
774 /* This shouldn't happen because we did a select() first, but handle anyway. */
777 /* This is an actual failure. */
778 RETURN_FAIL("write() failed");
781 bytes_written += result;
785 RETURN_INT(bytes_written);
789 SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
790 const void *buf, size_t count)
792 TRACE("%p, %p, %d", port, buf, count);
797 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
799 DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
806 BYTE *ptr = (BYTE *) buf;
808 /* Check whether previous write is complete. */
810 if (HasOverlappedIoCompleted(&port->write_ovl)) {
811 DEBUG("Previous write completed");
814 DEBUG("Previous write not complete");
815 /* Can't take a new write until the previous one finishes. */
821 port->timeouts.WriteTotalTimeoutConstant = 0;
822 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
823 RETURN_FAIL("SetCommTimeouts() failed");
825 /* Keep writing data until the OS has to actually start an async IO for it.
826 * At that point we know the buffer is full. */
827 while (written < count)
829 /* Copy first byte of user buffer. */
830 port->pending_byte = *ptr++;
832 /* Start asynchronous write. */
833 if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) {
834 if (GetLastError() == ERROR_IO_PENDING) {
835 if (HasOverlappedIoCompleted(&port->write_ovl)) {
836 DEBUG("Asynchronous write completed immediately");
841 DEBUG("Asynchronous write running");
843 RETURN_INT(++written);
846 /* Actual failure of some kind. */
847 RETURN_FAIL("WriteFile() failed");
850 DEBUG("Single byte written immediately");
855 DEBUG("All bytes written immediately");
859 /* Returns the number of bytes written, or -1 upon failure. */
860 ssize_t written = write(port->fd, buf, count);
863 RETURN_FAIL("write() failed");
869 SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
870 size_t count, unsigned int timeout)
872 TRACE("%p, %p, %d, %d", port, buf, count, timeout);
877 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
880 DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms",
881 count, port->name, timeout);
883 DEBUG_FMT("Reading %d bytes from port %s, no timeout",
890 DWORD bytes_read = 0;
893 port->timeouts.ReadIntervalTimeout = 0;
894 port->timeouts.ReadTotalTimeoutConstant = timeout;
895 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
896 RETURN_FAIL("SetCommTimeouts() failed");
899 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0) {
900 if (GetLastError() == ERROR_IO_PENDING) {
901 DEBUG("Waiting for read to complete");
902 GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
903 DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
905 RETURN_FAIL("ReadFile() failed");
908 DEBUG("Read completed immediately");
912 /* Start background operation for subsequent events. */
913 if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) {
914 if (GetLastError() != ERROR_IO_PENDING)
915 RETURN_FAIL("WaitCommEvent() failed");
918 RETURN_INT(bytes_read);
921 size_t bytes_read = 0;
922 unsigned char *ptr = (unsigned char *) buf;
923 struct timeval start, delta, now, end = {0, 0};
928 /* Get time at start of operation. */
929 gettimeofday(&start, NULL);
930 /* Define duration of timeout. */
931 delta.tv_sec = timeout / 1000;
932 delta.tv_usec = (timeout % 1000) * 1000;
933 /* Calculate time at which we should give up. */
934 timeradd(&start, &delta, &end);
937 /* Loop until we have the requested number of bytes. */
938 while (bytes_read < count)
940 /* Wait until data is available. */
942 FD_SET(port->fd, &fds);
944 gettimeofday(&now, NULL);
945 if (timercmp(&now, &end, >))
946 /* Timeout has expired. */
947 RETURN_INT(bytes_read);
948 timersub(&end, &now, &delta);
950 result = select(port->fd + 1, &fds, NULL, NULL, timeout ? &delta : NULL);
952 if (errno == EINTR) {
953 DEBUG("select() call was interrupted, repeating");
956 RETURN_FAIL("select() failed");
958 } else if (result == 0) {
959 DEBUG("read timed out");
960 RETURN_INT(bytes_read);
964 result = read(port->fd, ptr, count - bytes_read);
968 /* This shouldn't happen because we did a select() first, but handle anyway. */
971 /* This is an actual failure. */
972 RETURN_FAIL("read() failed");
975 bytes_read += result;
979 RETURN_INT(bytes_read);
983 SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
986 TRACE("%p, %p, %d", port, buf, count);
991 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
993 DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
999 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1000 port->timeouts.ReadTotalTimeoutConstant = 0;
1001 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1002 RETURN_FAIL("SetCommTimeouts() failed");
1005 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
1006 RETURN_FAIL("ReadFile() failed");
1008 /* Get number of bytes read. */
1009 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1010 RETURN_FAIL("GetOverlappedResult() failed");
1012 if (bytes_read > 0) {
1013 /* Start background operation for subsequent events. */
1014 if (WaitCommEvent(port->hdl, &port->events, &port->wait_ovl) == 0) {
1015 if (GetLastError() != ERROR_IO_PENDING)
1016 RETURN_FAIL("WaitCommEvent() failed");
1020 RETURN_INT(bytes_read);
1024 /* Returns the number of bytes read, or -1 upon failure. */
1025 if ((bytes_read = read(port->fd, buf, count)) < 0) {
1026 if (errno == EAGAIN)
1027 /* No bytes available. */
1030 /* This is an actual failure. */
1031 RETURN_FAIL("read() failed");
1033 RETURN_INT(bytes_read);
1037 SP_API enum sp_return sp_input_waiting(struct sp_port *port)
1043 DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
1049 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1050 RETURN_FAIL("ClearCommError() failed");
1051 RETURN_INT(comstat.cbInQue);
1054 if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1055 RETURN_FAIL("TIOCINQ ioctl failed");
1056 RETURN_INT(bytes_waiting);
1060 SP_API enum sp_return sp_output_waiting(struct sp_port *port)
1066 DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
1072 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1073 RETURN_FAIL("ClearCommError() failed");
1074 RETURN_INT(comstat.cbOutQue);
1077 if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1078 RETURN_FAIL("TIOCOUTQ ioctl failed");
1079 RETURN_INT(bytes_waiting);
1083 SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
1085 struct sp_event_set *result;
1087 TRACE("%p", result_ptr);
1090 RETURN_ERROR(SP_ERR_ARG, "Null result");
1094 if (!(result = malloc(sizeof(struct sp_event_set))))
1095 RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
1097 memset(result, 0, sizeof(struct sp_event_set));
1099 *result_ptr = result;
1104 static enum sp_return add_handle(struct sp_event_set *event_set,
1105 event_handle handle, enum sp_event mask)
1108 enum sp_event *new_masks;
1110 TRACE("%p, %d, %d", event_set, handle, mask);
1112 if (!(new_handles = realloc(event_set->handles,
1113 sizeof(event_handle) * (event_set->count + 1))))
1114 RETURN_ERROR(SP_ERR_MEM, "handle array realloc() failed");
1116 if (!(new_masks = realloc(event_set->masks,
1117 sizeof(enum sp_event) * (event_set->count + 1))))
1118 RETURN_ERROR(SP_ERR_MEM, "mask array realloc() failed");
1120 event_set->handles = new_handles;
1121 event_set->masks = new_masks;
1123 ((event_handle *) event_set->handles)[event_set->count] = handle;
1124 event_set->masks[event_set->count] = mask;
1131 SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1132 const struct sp_port *port, enum sp_event mask)
1134 TRACE("%p, %p, %d", event_set, port, mask);
1137 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1140 RETURN_ERROR(SP_ERR_ARG, "Null port");
1142 if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
1143 RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
1149 enum sp_event handle_mask;
1150 if ((handle_mask = mask & SP_EVENT_TX_READY))
1151 TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
1152 if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
1153 TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
1155 TRY(add_handle(event_set, port->fd, mask));
1161 SP_API void sp_free_event_set(struct sp_event_set *event_set)
1163 TRACE("%p", event_set);
1166 DEBUG("Null event set");
1170 DEBUG("Freeing event set");
1172 if (event_set->handles)
1173 free(event_set->handles);
1174 if (event_set->masks)
1175 free(event_set->masks);
1182 SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
1183 unsigned int timeout)
1185 TRACE("%p, %d", event_set, timeout);
1188 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1191 if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
1192 timeout ? timeout : INFINITE) == WAIT_FAILED)
1193 RETURN_FAIL("WaitForMultipleObjects() failed");
1197 struct timeval start, delta, now, end = {0, 0};
1198 int result, timeout_remaining;
1199 struct pollfd *pollfds;
1202 if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
1203 RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
1205 for (i = 0; i < event_set->count; i++) {
1206 pollfds[i].fd = ((int *) event_set->handles)[i];
1207 pollfds[i].events = 0;
1208 pollfds[i].revents = 0;
1209 if (event_set->masks[i] & SP_EVENT_RX_READY)
1210 pollfds[i].events |= POLLIN;
1211 if (event_set->masks[i] & SP_EVENT_TX_READY)
1212 pollfds[i].events |= POLLOUT;
1213 if (event_set->masks[i] & SP_EVENT_ERROR)
1214 pollfds[i].events |= POLLERR;
1218 /* Get time at start of operation. */
1219 gettimeofday(&start, NULL);
1220 /* Define duration of timeout. */
1221 delta.tv_sec = timeout / 1000;
1222 delta.tv_usec = (timeout % 1000) * 1000;
1223 /* Calculate time at which we should give up. */
1224 timeradd(&start, &delta, &end);
1227 /* Loop until an event occurs. */
1231 gettimeofday(&now, NULL);
1232 if (timercmp(&now, &end, >)) {
1233 DEBUG("wait timed out");
1236 timersub(&end, &now, &delta);
1237 timeout_remaining = delta.tv_sec * 1000 + delta.tv_usec / 1000;
1240 result = poll(pollfds, event_set->count, timeout ? timeout_remaining : -1);
1243 if (errno == EINTR) {
1244 DEBUG("poll() call was interrupted, repeating");
1248 RETURN_FAIL("poll() failed");
1250 } else if (result == 0) {
1251 DEBUG("poll() timed out");
1254 DEBUG("poll() completed");
1264 #ifdef USE_TERMIOS_SPEED
1265 static enum sp_return get_baudrate(int fd, int *baudrate)
1269 TRACE("%d, %p", fd, baudrate);
1271 DEBUG("Getting baud rate");
1273 if (!(data = malloc(get_termios_size())))
1274 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1276 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1278 RETURN_FAIL("getting termios failed");
1281 *baudrate = get_termios_speed(data);
1288 static enum sp_return set_baudrate(int fd, int baudrate)
1292 TRACE("%d, %d", fd, baudrate);
1294 DEBUG("Getting baud rate");
1296 if (!(data = malloc(get_termios_size())))
1297 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1299 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1301 RETURN_FAIL("getting termios failed");
1304 DEBUG("Setting baud rate");
1306 set_termios_speed(data, baudrate);
1308 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1310 RETURN_FAIL("setting termios failed");
1317 #endif /* USE_TERMIOS_SPEED */
1320 static enum sp_return get_flow(int fd, struct port_data *data)
1324 TRACE("%d, %p", fd, data);
1326 DEBUG("Getting advanced flow control");
1328 if (!(termx = malloc(get_termiox_size())))
1329 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1331 if (ioctl(fd, TCGETX, termx) < 0) {
1333 RETURN_FAIL("getting termiox failed");
1336 get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
1337 &data->dtr_flow, &data->dsr_flow);
1344 static enum sp_return set_flow(int fd, struct port_data *data)
1348 TRACE("%d, %p", fd, data);
1350 DEBUG("Getting advanced flow control");
1352 if (!(termx = malloc(get_termiox_size())))
1353 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1355 if (ioctl(fd, TCGETX, termx) < 0) {
1357 RETURN_FAIL("getting termiox failed");
1360 DEBUG("Setting advanced flow control");
1362 set_termiox_flow(termx, data->rts_flow, data->cts_flow,
1363 data->dtr_flow, data->dsr_flow);
1365 if (ioctl(fd, TCSETX, termx) < 0) {
1367 RETURN_FAIL("setting termiox failed");
1374 #endif /* USE_TERMIOX */
1376 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1377 struct sp_port_config *config)
1381 TRACE("%p, %p, %p", port, data, config);
1383 DEBUG_FMT("Getting configuration for port %s", port->name);
1386 if (!GetCommState(port->hdl, &data->dcb))
1387 RETURN_FAIL("GetCommState() failed");
1389 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1390 if (data->dcb.BaudRate == std_baudrates[i].index) {
1391 config->baudrate = std_baudrates[i].value;
1396 if (i == NUM_STD_BAUDRATES)
1397 /* BaudRate field can be either an index or a custom baud rate. */
1398 config->baudrate = data->dcb.BaudRate;
1400 config->bits = data->dcb.ByteSize;
1402 if (data->dcb.fParity)
1403 switch (data->dcb.Parity) {
1405 config->parity = SP_PARITY_NONE;
1408 config->parity = SP_PARITY_ODD;
1411 config->parity = SP_PARITY_EVEN;
1414 config->parity = SP_PARITY_MARK;
1417 config->parity = SP_PARITY_SPACE;
1420 config->parity = -1;
1423 config->parity = SP_PARITY_NONE;
1425 switch (data->dcb.StopBits) {
1427 config->stopbits = 1;
1430 config->stopbits = 2;
1433 config->stopbits = -1;
1436 switch (data->dcb.fRtsControl) {
1437 case RTS_CONTROL_DISABLE:
1438 config->rts = SP_RTS_OFF;
1440 case RTS_CONTROL_ENABLE:
1441 config->rts = SP_RTS_ON;
1443 case RTS_CONTROL_HANDSHAKE:
1444 config->rts = SP_RTS_FLOW_CONTROL;
1450 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1452 switch (data->dcb.fDtrControl) {
1453 case DTR_CONTROL_DISABLE:
1454 config->dtr = SP_DTR_OFF;
1456 case DTR_CONTROL_ENABLE:
1457 config->dtr = SP_DTR_ON;
1459 case DTR_CONTROL_HANDSHAKE:
1460 config->dtr = SP_DTR_FLOW_CONTROL;
1466 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1468 if (data->dcb.fInX) {
1469 if (data->dcb.fOutX)
1470 config->xon_xoff = SP_XONXOFF_INOUT;
1472 config->xon_xoff = SP_XONXOFF_IN;
1474 if (data->dcb.fOutX)
1475 config->xon_xoff = SP_XONXOFF_OUT;
1477 config->xon_xoff = SP_XONXOFF_DISABLED;
1482 if (tcgetattr(port->fd, &data->term) < 0)
1483 RETURN_FAIL("tcgetattr() failed");
1485 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1486 RETURN_FAIL("TIOCMGET ioctl failed");
1489 int ret = get_flow(port->fd, data);
1491 if (ret == SP_ERR_FAIL && errno == EINVAL)
1492 data->termiox_supported = 0;
1494 RETURN_CODEVAL(ret);
1496 data->termiox_supported = 1;
1498 data->termiox_supported = 0;
1501 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1502 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1503 config->baudrate = std_baudrates[i].value;
1508 if (i == NUM_STD_BAUDRATES) {
1510 config->baudrate = (int)data->term.c_ispeed;
1511 #elif defined(USE_TERMIOS_SPEED)
1512 TRY(get_baudrate(port->fd, &config->baudrate));
1514 config->baudrate = -1;
1518 switch (data->term.c_cflag & CSIZE) {
1535 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1536 config->parity = SP_PARITY_NONE;
1537 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1538 config->parity = -1;
1540 else if (data->term.c_cflag & CMSPAR)
1541 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1544 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1546 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1548 if (data->term.c_cflag & CRTSCTS) {
1549 config->rts = SP_RTS_FLOW_CONTROL;
1550 config->cts = SP_CTS_FLOW_CONTROL;
1552 if (data->termiox_supported && data->rts_flow)
1553 config->rts = SP_RTS_FLOW_CONTROL;
1555 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1557 config->cts = (data->termiox_supported && data->cts_flow) ?
1558 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1561 if (data->termiox_supported && data->dtr_flow)
1562 config->dtr = SP_DTR_FLOW_CONTROL;
1564 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1566 config->dsr = (data->termiox_supported && data->dsr_flow) ?
1567 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1569 if (data->term.c_iflag & IXOFF) {
1570 if (data->term.c_iflag & IXON)
1571 config->xon_xoff = SP_XONXOFF_INOUT;
1573 config->xon_xoff = SP_XONXOFF_IN;
1575 if (data->term.c_iflag & IXON)
1576 config->xon_xoff = SP_XONXOFF_OUT;
1578 config->xon_xoff = SP_XONXOFF_DISABLED;
1585 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1586 const struct sp_port_config *config)
1590 BAUD_TYPE baud_nonstd;
1594 #ifdef USE_TERMIOS_SPEED
1595 int baud_nonstd = 0;
1598 TRACE("%p, %p, %p", port, data, config);
1600 DEBUG_FMT("Setting configuration for port %s", port->name);
1603 if (config->baudrate >= 0) {
1604 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1605 if (config->baudrate == std_baudrates[i].value) {
1606 data->dcb.BaudRate = std_baudrates[i].index;
1611 if (i == NUM_STD_BAUDRATES)
1612 data->dcb.BaudRate = config->baudrate;
1615 if (config->bits >= 0)
1616 data->dcb.ByteSize = config->bits;
1618 if (config->parity >= 0) {
1619 switch (config->parity) {
1620 case SP_PARITY_NONE:
1621 data->dcb.Parity = NOPARITY;
1624 data->dcb.Parity = ODDPARITY;
1626 case SP_PARITY_EVEN:
1627 data->dcb.Parity = EVENPARITY;
1629 case SP_PARITY_MARK:
1630 data->dcb.Parity = MARKPARITY;
1632 case SP_PARITY_SPACE:
1633 data->dcb.Parity = SPACEPARITY;
1636 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1640 if (config->stopbits >= 0) {
1641 switch (config->stopbits) {
1642 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1644 data->dcb.StopBits = ONESTOPBIT;
1647 data->dcb.StopBits = TWOSTOPBITS;
1650 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1654 if (config->rts >= 0) {
1655 switch (config->rts) {
1657 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1660 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1662 case SP_RTS_FLOW_CONTROL:
1663 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1666 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1670 if (config->cts >= 0) {
1671 switch (config->cts) {
1673 data->dcb.fOutxCtsFlow = FALSE;
1675 case SP_CTS_FLOW_CONTROL:
1676 data->dcb.fOutxCtsFlow = TRUE;
1679 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1683 if (config->dtr >= 0) {
1684 switch (config->dtr) {
1686 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1689 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1691 case SP_DTR_FLOW_CONTROL:
1692 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1695 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1699 if (config->dsr >= 0) {
1700 switch (config->dsr) {
1702 data->dcb.fOutxDsrFlow = FALSE;
1704 case SP_DSR_FLOW_CONTROL:
1705 data->dcb.fOutxDsrFlow = TRUE;
1708 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1712 if (config->xon_xoff >= 0) {
1713 switch (config->xon_xoff) {
1714 case SP_XONXOFF_DISABLED:
1715 data->dcb.fInX = FALSE;
1716 data->dcb.fOutX = FALSE;
1719 data->dcb.fInX = TRUE;
1720 data->dcb.fOutX = FALSE;
1722 case SP_XONXOFF_OUT:
1723 data->dcb.fInX = FALSE;
1724 data->dcb.fOutX = TRUE;
1726 case SP_XONXOFF_INOUT:
1727 data->dcb.fInX = TRUE;
1728 data->dcb.fOutX = TRUE;
1731 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1735 if (!SetCommState(port->hdl, &data->dcb))
1736 RETURN_FAIL("SetCommState() failed");
1742 if (config->baudrate >= 0) {
1743 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1744 if (config->baudrate == std_baudrates[i].value) {
1745 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1746 RETURN_FAIL("cfsetospeed() failed");
1748 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1749 RETURN_FAIL("cfsetispeed() failed");
1754 /* Non-standard baud rate */
1755 if (i == NUM_STD_BAUDRATES) {
1757 /* Set "dummy" baud rate. */
1758 if (cfsetspeed(&data->term, B9600) < 0)
1759 RETURN_FAIL("cfsetspeed() failed");
1760 baud_nonstd = config->baudrate;
1761 #elif defined(USE_TERMIOS_SPEED)
1764 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
1769 if (config->bits >= 0) {
1770 data->term.c_cflag &= ~CSIZE;
1771 switch (config->bits) {
1773 data->term.c_cflag |= CS8;
1776 data->term.c_cflag |= CS7;
1779 data->term.c_cflag |= CS6;
1782 data->term.c_cflag |= CS5;
1785 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
1789 if (config->parity >= 0) {
1790 data->term.c_iflag &= ~IGNPAR;
1791 data->term.c_cflag &= ~(PARENB | PARODD);
1793 data->term.c_cflag &= ~CMSPAR;
1795 switch (config->parity) {
1796 case SP_PARITY_NONE:
1797 data->term.c_iflag |= IGNPAR;
1799 case SP_PARITY_EVEN:
1800 data->term.c_cflag |= PARENB;
1803 data->term.c_cflag |= PARENB | PARODD;
1806 case SP_PARITY_MARK:
1807 data->term.c_cflag |= PARENB | PARODD;
1808 data->term.c_cflag |= CMSPAR;
1810 case SP_PARITY_SPACE:
1811 data->term.c_cflag |= PARENB;
1812 data->term.c_cflag |= CMSPAR;
1815 case SP_PARITY_MARK:
1816 case SP_PARITY_SPACE:
1817 RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
1820 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1824 if (config->stopbits >= 0) {
1825 data->term.c_cflag &= ~CSTOPB;
1826 switch (config->stopbits) {
1828 data->term.c_cflag &= ~CSTOPB;
1831 data->term.c_cflag |= CSTOPB;
1834 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
1838 if (config->rts >= 0 || config->cts >= 0) {
1839 if (data->termiox_supported) {
1840 data->rts_flow = data->cts_flow = 0;
1841 switch (config->rts) {
1844 controlbits = TIOCM_RTS;
1845 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1846 RETURN_FAIL("Setting RTS signal level failed");
1848 case SP_RTS_FLOW_CONTROL:
1854 if (config->cts == SP_CTS_FLOW_CONTROL)
1857 if (data->rts_flow && data->cts_flow)
1858 data->term.c_iflag |= CRTSCTS;
1860 data->term.c_iflag &= ~CRTSCTS;
1862 /* Asymmetric use of RTS/CTS not supported. */
1863 if (data->term.c_iflag & CRTSCTS) {
1864 /* Flow control can only be disabled for both RTS & CTS together. */
1865 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1866 if (config->cts != SP_CTS_IGNORE)
1867 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1869 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1870 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
1871 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1874 /* Flow control can only be enabled for both RTS & CTS together. */
1875 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1876 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
1877 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
1880 if (config->rts >= 0) {
1881 if (config->rts == SP_RTS_FLOW_CONTROL) {
1882 data->term.c_iflag |= CRTSCTS;
1884 controlbits = TIOCM_RTS;
1885 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1887 RETURN_FAIL("Setting RTS signal level failed");
1893 if (config->dtr >= 0 || config->dsr >= 0) {
1894 if (data->termiox_supported) {
1895 data->dtr_flow = data->dsr_flow = 0;
1896 switch (config->dtr) {
1899 controlbits = TIOCM_DTR;
1900 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1901 RETURN_FAIL("Setting DTR signal level failed");
1903 case SP_DTR_FLOW_CONTROL:
1909 if (config->dsr == SP_DSR_FLOW_CONTROL)
1912 /* DTR/DSR flow control not supported. */
1913 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
1914 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
1916 if (config->dtr >= 0) {
1917 controlbits = TIOCM_DTR;
1918 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1920 RETURN_FAIL("Setting DTR signal level failed");
1925 if (config->xon_xoff >= 0) {
1926 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
1927 switch (config->xon_xoff) {
1928 case SP_XONXOFF_DISABLED:
1931 data->term.c_iflag |= IXOFF;
1933 case SP_XONXOFF_OUT:
1934 data->term.c_iflag |= IXON | IXANY;
1936 case SP_XONXOFF_INOUT:
1937 data->term.c_iflag |= IXON | IXOFF | IXANY;
1940 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1944 if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
1945 RETURN_FAIL("tcsetattr() failed");
1948 if (baud_nonstd != B0) {
1949 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
1950 RETURN_FAIL("IOSSIOSPEED ioctl failed");
1951 /* Set baud rates in data->term to correct, but incompatible
1952 * with tcsetattr() value, same as delivered by tcgetattr(). */
1953 if (cfsetspeed(&data->term, baud_nonstd) < 0)
1954 RETURN_FAIL("cfsetspeed() failed");
1956 #elif defined(__linux__)
1957 #ifdef USE_TERMIOS_SPEED
1959 TRY(set_baudrate(port->fd, config->baudrate));
1962 if (data->termiox_supported)
1963 TRY(set_flow(port->fd, data));
1967 #endif /* !_WIN32 */
1972 SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
1974 struct sp_port_config *config;
1976 TRACE("%p", config_ptr);
1979 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
1983 if (!(config = malloc(sizeof(struct sp_port_config))))
1984 RETURN_ERROR(SP_ERR_MEM, "config malloc failed");
1986 config->baudrate = -1;
1988 config->parity = -1;
1989 config->stopbits = -1;
1995 *config_ptr = config;
2000 SP_API void sp_free_config(struct sp_port_config *config)
2002 TRACE("%p", config);
2005 DEBUG("Null config");
2012 SP_API enum sp_return sp_get_config(struct sp_port *port,
2013 struct sp_port_config *config)
2015 struct port_data data;
2017 TRACE("%p, %p", port, config);
2022 RETURN_ERROR(SP_ERR_ARG, "Null config");
2024 TRY(get_config(port, &data, config));
2029 SP_API enum sp_return sp_set_config(struct sp_port *port,
2030 const struct sp_port_config *config)
2032 struct port_data data;
2033 struct sp_port_config prev_config;
2035 TRACE("%p, %p", port, config);
2040 RETURN_ERROR(SP_ERR_ARG, "Null config");
2042 TRY(get_config(port, &data, &prev_config));
2043 TRY(set_config(port, &data, config));
2048 #define CREATE_ACCESSORS(x, type) \
2049 SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2050 struct port_data data; \
2051 struct sp_port_config config; \
2052 TRACE("%p, %d", port, x); \
2053 CHECK_OPEN_PORT(); \
2054 TRY(get_config(port, &data, &config)); \
2056 TRY(set_config(port, &data, &config)); \
2059 SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \
2061 TRACE("%p, %p", config, x); \
2063 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2067 SP_API enum sp_return sp_set_config_##x(struct sp_port_config *config, \
2069 TRACE("%p, %d", config, x); \
2071 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2076 CREATE_ACCESSORS(baudrate, int)
2077 CREATE_ACCESSORS(bits, int)
2078 CREATE_ACCESSORS(parity, enum sp_parity)
2079 CREATE_ACCESSORS(stopbits, int)
2080 CREATE_ACCESSORS(rts, enum sp_rts)
2081 CREATE_ACCESSORS(cts, enum sp_cts)
2082 CREATE_ACCESSORS(dtr, enum sp_dtr)
2083 CREATE_ACCESSORS(dsr, enum sp_dsr)
2084 CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2086 SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config,
2087 enum sp_flowcontrol flowcontrol)
2090 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2092 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2093 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2095 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2096 config->xon_xoff = SP_XONXOFF_INOUT;
2098 config->xon_xoff = SP_XONXOFF_DISABLED;
2100 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2101 config->rts = SP_RTS_FLOW_CONTROL;
2102 config->cts = SP_CTS_FLOW_CONTROL;
2104 if (config->rts == SP_RTS_FLOW_CONTROL)
2105 config->rts = SP_RTS_ON;
2106 config->cts = SP_CTS_IGNORE;
2109 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2110 config->dtr = SP_DTR_FLOW_CONTROL;
2111 config->dsr = SP_DSR_FLOW_CONTROL;
2113 if (config->dtr == SP_DTR_FLOW_CONTROL)
2114 config->dtr = SP_DTR_ON;
2115 config->dsr = SP_DSR_IGNORE;
2121 SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port,
2122 enum sp_flowcontrol flowcontrol)
2124 struct port_data data;
2125 struct sp_port_config config;
2127 TRACE("%p, %d", port, flowcontrol);
2131 TRY(get_config(port, &data, &config));
2133 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2135 TRY(set_config(port, &data, &config));
2140 SP_API enum sp_return sp_get_signals(struct sp_port *port,
2141 enum sp_signal *signals)
2143 TRACE("%p, %p", port, signals);
2148 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2150 DEBUG_FMT("Getting control signals for port %s", port->name);
2155 if (GetCommModemStatus(port->hdl, &bits) == 0)
2156 RETURN_FAIL("GetCommModemStatus() failed");
2157 if (bits & MS_CTS_ON)
2158 *signals |= SP_SIG_CTS;
2159 if (bits & MS_DSR_ON)
2160 *signals |= SP_SIG_DSR;
2161 if (bits & MS_RLSD_ON)
2162 *signals |= SP_SIG_DCD;
2163 if (bits & MS_RING_ON)
2164 *signals |= SP_SIG_RI;
2167 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2168 RETURN_FAIL("TIOCMGET ioctl failed");
2169 if (bits & TIOCM_CTS)
2170 *signals |= SP_SIG_CTS;
2171 if (bits & TIOCM_DSR)
2172 *signals |= SP_SIG_DSR;
2173 if (bits & TIOCM_CAR)
2174 *signals |= SP_SIG_DCD;
2175 if (bits & TIOCM_RNG)
2176 *signals |= SP_SIG_RI;
2181 SP_API enum sp_return sp_start_break(struct sp_port *port)
2187 if (SetCommBreak(port->hdl) == 0)
2188 RETURN_FAIL("SetCommBreak() failed");
2190 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2191 RETURN_FAIL("TIOCSBRK ioctl failed");
2197 SP_API enum sp_return sp_end_break(struct sp_port *port)
2203 if (ClearCommBreak(port->hdl) == 0)
2204 RETURN_FAIL("ClearCommBreak() failed");
2206 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2207 RETURN_FAIL("TIOCCBRK ioctl failed");
2213 SP_API int sp_last_error_code(void)
2217 RETURN_INT(GetLastError());
2223 SP_API char *sp_last_error_message(void)
2229 DWORD error = GetLastError();
2232 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2233 FORMAT_MESSAGE_FROM_SYSTEM |
2234 FORMAT_MESSAGE_IGNORE_INSERTS,
2237 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2241 RETURN_STRING(message);
2243 RETURN_STRING(strerror(errno));
2247 SP_API void sp_free_error_message(char *message)
2249 TRACE("%s", message);
2260 SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...))
2262 TRACE("%p", handler);
2264 sp_debug_handler = handler;
2269 SP_API void sp_default_debug_handler(const char *format, ...)
2272 va_start(args, format);
2273 if (getenv("LIBSERIALPORT_DEBUG")) {
2274 fputs("sp: ", stderr);
2275 vfprintf(stderr, format, args);
2280 SP_API int sp_get_major_package_version(void)
2282 return SP_PACKAGE_VERSION_MAJOR;
2285 SP_API int sp_get_minor_package_version(void)
2287 return SP_PACKAGE_VERSION_MINOR;
2290 SP_API int sp_get_micro_package_version(void)
2292 return SP_PACKAGE_VERSION_MICRO;
2295 SP_API const char *sp_get_package_version_string(void)
2297 return SP_PACKAGE_VERSION_STRING;
2300 SP_API int sp_get_current_lib_version(void)
2302 return SP_LIB_VERSION_CURRENT;
2305 SP_API int sp_get_revision_lib_version(void)
2307 return SP_LIB_VERSION_REVISION;
2310 SP_API int sp_get_age_lib_version(void)
2312 return SP_LIB_VERSION_AGE;
2315 SP_API const char *sp_get_lib_version_string(void)
2317 return SP_LIB_VERSION_STRING;