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 static 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 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
49 void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
51 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
52 struct sp_port_config *config);
54 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
55 const struct sp_port_config *config);
57 SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
60 #ifndef NO_PORT_METADATA
65 TRACE("%s, %p", portname, port_ptr);
68 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
73 RETURN_ERROR(SP_ERR_ARG, "Null port name");
75 DEBUG_FMT("Building structure for port %s", portname);
77 if (!(port = malloc(sizeof(struct sp_port))))
78 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
80 len = strlen(portname) + 1;
82 if (!(port->name = malloc(len))) {
84 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
87 memcpy(port->name, portname, len);
90 port->usb_path = NULL;
91 port->hdl = INVALID_HANDLE_VALUE;
96 port->description = NULL;
97 port->transport = SP_TRANSPORT_NATIVE;
99 port->usb_address = -1;
102 port->usb_manufacturer = NULL;
103 port->usb_product = NULL;
104 port->usb_serial = NULL;
105 port->bluetooth_address = NULL;
107 #ifndef NO_PORT_METADATA
108 if ((ret = get_port_details(port)) != SP_OK) {
119 SP_API char *sp_get_port_name(const struct sp_port *port)
126 RETURN_STRING(port->name);
129 SP_API char *sp_get_port_description(const struct sp_port *port)
133 if (!port || !port->description)
136 RETURN_STRING(port->description);
139 SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port)
144 RETURN_ERROR(SP_ERR_ARG, "Null port");
146 RETURN_INT(port->transport);
149 SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
150 int *usb_bus,int *usb_address)
155 RETURN_ERROR(SP_ERR_ARG, "Null port");
156 if (port->transport != SP_TRANSPORT_USB)
157 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
158 if (port->usb_bus < 0 || port->usb_address < 0)
159 RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available");
162 *usb_bus = port->usb_bus;
164 *usb_address = port->usb_address;
169 SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
170 int *usb_vid, int *usb_pid)
175 RETURN_ERROR(SP_ERR_ARG, "Null port");
176 if (port->transport != SP_TRANSPORT_USB)
177 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
178 if (port->usb_vid < 0 || port->usb_pid < 0)
179 RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available");
182 *usb_vid = port->usb_vid;
184 *usb_pid = port->usb_pid;
189 SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port)
193 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
196 RETURN_STRING(port->usb_manufacturer);
199 SP_API char *sp_get_port_usb_product(const struct sp_port *port)
203 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
206 RETURN_STRING(port->usb_product);
209 SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
213 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
216 RETURN_STRING(port->usb_serial);
219 SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
223 if (!port || port->transport != SP_TRANSPORT_BLUETOOTH
224 || !port->bluetooth_address)
227 RETURN_STRING(port->bluetooth_address);
230 SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
233 TRACE("%p, %p", port, result_ptr);
236 RETURN_ERROR(SP_ERR_ARG, "Null port");
238 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
241 HANDLE *handle_ptr = result_ptr;
242 *handle_ptr = port->hdl;
244 int *fd_ptr = result_ptr;
251 SP_API enum sp_return sp_copy_port(const struct sp_port *port,
252 struct sp_port **copy_ptr)
254 TRACE("%p, %p", port, copy_ptr);
257 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
262 RETURN_ERROR(SP_ERR_ARG, "Null port");
265 RETURN_ERROR(SP_ERR_ARG, "Null port name");
267 DEBUG("Copying port structure");
269 RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
272 SP_API void sp_free_port(struct sp_port *port)
281 DEBUG("Freeing port structure");
285 if (port->description)
286 free(port->description);
287 if (port->usb_manufacturer)
288 free(port->usb_manufacturer);
289 if (port->usb_product)
290 free(port->usb_product);
291 if (port->usb_serial)
292 free(port->usb_serial);
293 if (port->bluetooth_address)
294 free(port->bluetooth_address);
297 free(port->usb_path);
305 SP_PRIV struct sp_port **list_append(struct sp_port **list,
306 const char *portname)
311 for (count = 0; list[count]; count++);
312 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
315 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
317 list[count + 1] = NULL;
321 sp_free_port_list(list);
325 SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr)
327 #ifndef NO_ENUMERATION
328 struct sp_port **list;
332 TRACE("%p", list_ptr);
335 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
339 #ifdef NO_ENUMERATION
340 RETURN_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
342 DEBUG("Enumerating ports");
344 if (!(list = malloc(sizeof(struct sp_port *))))
345 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
349 ret = list_ports(&list);
354 sp_free_port_list(list);
362 SP_API void sp_free_port_list(struct sp_port **list)
373 DEBUG("Freeing port list");
375 for (i = 0; list[i]; i++)
376 sp_free_port(list[i]);
382 #define CHECK_PORT() do { \
384 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
386 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
389 #define CHECK_PORT_HANDLE() do { \
390 if (port->hdl == INVALID_HANDLE_VALUE) \
391 RETURN_ERROR(SP_ERR_ARG, "Invalid port handle"); \
394 #define CHECK_PORT_HANDLE() do { \
396 RETURN_ERROR(SP_ERR_ARG, "Invalid port fd"); \
399 #define CHECK_OPEN_PORT() do { \
401 CHECK_PORT_HANDLE(); \
405 /** To be called after port receive buffer is emptied. */
406 static enum sp_return restart_wait(struct sp_port *port)
410 if (port->wait_running) {
411 /* Check status of running wait operation. */
412 if (GetOverlappedResult(port->hdl, &port->wait_ovl,
413 &wait_result, FALSE)) {
414 DEBUG("Previous wait completed");
415 port->wait_running = FALSE;
416 } else if (GetLastError() == ERROR_IO_INCOMPLETE) {
417 DEBUG("Previous wait still running");
420 RETURN_FAIL("GetOverlappedResult() failed");
424 if (!port->wait_running) {
425 /* Start new wait operation. */
426 if (WaitCommEvent(port->hdl, &port->events,
428 DEBUG("New wait returned, events already pending");
429 } else if (GetLastError() == ERROR_IO_PENDING) {
430 DEBUG("New wait running in background");
431 port->wait_running = TRUE;
433 RETURN_FAIL("WaitCommEvent() failed");
441 SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
443 struct port_data data;
444 struct sp_port_config config;
447 TRACE("%p, 0x%x", port, flags);
451 if (flags > SP_MODE_READ_WRITE)
452 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
454 DEBUG_FMT("Opening port %s", port->name);
457 DWORD desired_access = 0, flags_and_attributes = 0, errors;
458 char *escaped_port_name;
461 /* Prefix port name with '\\.\' to work with ports above COM9. */
462 if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
463 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
464 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
466 /* Map 'flags' to the OS-specific settings. */
467 flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
468 if (flags & SP_MODE_READ)
469 desired_access |= GENERIC_READ;
470 if (flags & SP_MODE_WRITE)
471 desired_access |= GENERIC_WRITE;
473 port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
474 OPEN_EXISTING, flags_and_attributes, 0);
476 free(escaped_port_name);
478 if (port->hdl == INVALID_HANDLE_VALUE)
479 RETURN_FAIL("Port CreateFile() failed");
481 /* All timeouts initially disabled. */
482 port->timeouts.ReadIntervalTimeout = 0;
483 port->timeouts.ReadTotalTimeoutMultiplier = 0;
484 port->timeouts.ReadTotalTimeoutConstant = 0;
485 port->timeouts.WriteTotalTimeoutMultiplier = 0;
486 port->timeouts.WriteTotalTimeoutConstant = 0;
488 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
490 RETURN_FAIL("SetCommTimeouts() failed");
493 /* Prepare OVERLAPPED structures. */
494 #define INIT_OVERLAPPED(ovl) do { \
495 memset(&port->ovl, 0, sizeof(port->ovl)); \
496 port->ovl.hEvent = INVALID_HANDLE_VALUE; \
497 if ((port->ovl.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL)) \
498 == INVALID_HANDLE_VALUE) { \
500 RETURN_FAIL(#ovl "CreateEvent() failed"); \
504 INIT_OVERLAPPED(read_ovl);
505 INIT_OVERLAPPED(write_ovl);
506 INIT_OVERLAPPED(wait_ovl);
508 /* Set event mask for RX and error events. */
509 if (SetCommMask(port->hdl, EV_RXCHAR | EV_ERR) == 0) {
511 RETURN_FAIL("SetCommMask() failed");
514 port->writing = FALSE;
515 port->wait_running = FALSE;
517 ret = restart_wait(port);
524 int flags_local = O_NONBLOCK | O_NOCTTY;
526 /* Map 'flags' to the OS-specific settings. */
527 if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
528 flags_local |= O_RDWR;
529 else if (flags & SP_MODE_READ)
530 flags_local |= O_RDONLY;
531 else if (flags & SP_MODE_WRITE)
532 flags_local |= O_WRONLY;
534 if ((port->fd = open(port->name, flags_local)) < 0)
535 RETURN_FAIL("open() failed");
538 ret = get_config(port, &data, &config);
545 /* Set sane port settings. */
547 data.dcb.fBinary = TRUE;
548 data.dcb.fDsrSensitivity = FALSE;
549 data.dcb.fErrorChar = FALSE;
550 data.dcb.fNull = FALSE;
551 data.dcb.fAbortOnError = FALSE;
553 /* Turn off all fancy termios tricks, give us a raw channel. */
554 data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
556 data.term.c_iflag &= ~IUCLC;
558 data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET);
560 data.term.c_oflag &= ~OLCUC;
563 data.term.c_oflag &= ~NLDLY;
566 data.term.c_oflag &= ~CRDLY;
569 data.term.c_oflag &= ~TABDLY;
572 data.term.c_oflag &= ~BSDLY;
575 data.term.c_oflag &= ~VTDLY;
578 data.term.c_oflag &= ~FFDLY;
581 data.term.c_oflag &= ~OFILL;
583 data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
584 data.term.c_cc[VMIN] = 0;
585 data.term.c_cc[VTIME] = 0;
587 /* Ignore modem status lines; enable receiver; leave control lines alone on close. */
588 data.term.c_cflag |= (CLOCAL | CREAD | HUPCL);
592 if (ClearCommError(port->hdl, &errors, &status) == 0)
593 RETURN_FAIL("ClearCommError() failed");
596 ret = set_config(port, &data, &config);
606 SP_API enum sp_return sp_close(struct sp_port *port)
612 DEBUG_FMT("Closing port %s", port->name);
615 /* Returns non-zero upon success, 0 upon failure. */
616 if (CloseHandle(port->hdl) == 0)
617 RETURN_FAIL("Port CloseHandle() failed");
618 port->hdl = INVALID_HANDLE_VALUE;
620 /* Close event handles for overlapped structures. */
621 #define CLOSE_OVERLAPPED(ovl) do { \
622 if (port->ovl.hEvent != INVALID_HANDLE_VALUE && \
623 CloseHandle(port->ovl.hEvent) == 0) \
624 RETURN_FAIL(# ovl "event CloseHandle() failed"); \
626 CLOSE_OVERLAPPED(read_ovl);
627 CLOSE_OVERLAPPED(write_ovl);
628 CLOSE_OVERLAPPED(wait_ovl);
631 /* Returns 0 upon success, -1 upon failure. */
632 if (close(port->fd) == -1)
633 RETURN_FAIL("close() failed");
640 SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
642 TRACE("%p, 0x%x", port, buffers);
646 if (buffers > SP_BUF_BOTH)
647 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
649 const char *buffer_names[] = {"no", "input", "output", "both"};
651 DEBUG_FMT("Flushing %s buffers on port %s",
652 buffer_names[buffers], port->name);
656 if (buffers & SP_BUF_INPUT)
657 flags |= PURGE_RXCLEAR;
658 if (buffers & SP_BUF_OUTPUT)
659 flags |= PURGE_TXCLEAR;
661 /* Returns non-zero upon success, 0 upon failure. */
662 if (PurgeComm(port->hdl, flags) == 0)
663 RETURN_FAIL("PurgeComm() failed");
665 if (buffers & SP_BUF_INPUT)
666 TRY(restart_wait(port));
669 if (buffers == SP_BUF_BOTH)
671 else if (buffers == SP_BUF_INPUT)
673 else if (buffers == SP_BUF_OUTPUT)
676 /* Returns 0 upon success, -1 upon failure. */
677 if (tcflush(port->fd, flags) < 0)
678 RETURN_FAIL("tcflush() failed");
683 SP_API enum sp_return sp_drain(struct sp_port *port)
689 DEBUG_FMT("Draining port %s", port->name);
692 /* Returns non-zero upon success, 0 upon failure. */
693 if (FlushFileBuffers(port->hdl) == 0)
694 RETURN_FAIL("FlushFileBuffers() failed");
701 result = ioctl(port->fd, TCSBRK, &arg);
703 result = tcdrain(port->fd);
706 if (errno == EINTR) {
707 DEBUG("tcdrain() was interrupted");
710 RETURN_FAIL("tcdrain() failed");
719 SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
720 size_t count, unsigned int timeout_ms)
722 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
727 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
730 DEBUG_FMT("Writing %d bytes to port %s, timeout %d ms",
731 count, port->name, timeout_ms);
733 DEBUG_FMT("Writing %d bytes to port %s, no timeout",
740 DWORD bytes_written = 0;
743 /* Wait for previous non-blocking write to complete, if any. */
745 DEBUG("Waiting for previous write to complete");
746 result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
749 RETURN_FAIL("Previous write failed to complete");
750 DEBUG("Previous write completed");
754 port->timeouts.WriteTotalTimeoutConstant = timeout_ms;
755 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
756 RETURN_FAIL("SetCommTimeouts() failed");
759 if (WriteFile(port->hdl, buf, count, NULL, &port->write_ovl) == 0) {
760 if (GetLastError() == ERROR_IO_PENDING) {
761 DEBUG("Waiting for write to complete");
762 GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
763 DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, count);
764 RETURN_INT(bytes_written);
766 RETURN_FAIL("WriteFile() failed");
769 DEBUG("Write completed immediately");
773 size_t bytes_written = 0;
774 unsigned char *ptr = (unsigned char *) buf;
775 struct timeval start, delta, now, end = {0, 0};
780 /* Get time at start of operation. */
781 gettimeofday(&start, NULL);
782 /* Define duration of timeout. */
783 delta.tv_sec = timeout_ms / 1000;
784 delta.tv_usec = (timeout_ms % 1000) * 1000;
785 /* Calculate time at which we should give up. */
786 timeradd(&start, &delta, &end);
789 /* Loop until we have written the requested number of bytes. */
790 while (bytes_written < count) {
791 /* Wait until space is available. */
793 FD_SET(port->fd, &fds);
795 gettimeofday(&now, NULL);
796 if (timercmp(&now, &end, >)) {
797 DEBUG("Write timed out");
798 RETURN_INT(bytes_written);
800 timersub(&end, &now, &delta);
802 result = select(port->fd + 1, NULL, &fds, NULL, timeout_ms ? &delta : NULL);
804 if (errno == EINTR) {
805 DEBUG("select() call was interrupted, repeating");
808 RETURN_FAIL("select() failed");
810 } else if (result == 0) {
811 DEBUG("Write timed out");
812 RETURN_INT(bytes_written);
816 result = write(port->fd, ptr, count - bytes_written);
820 /* This shouldn't happen because we did a select() first, but handle anyway. */
823 /* This is an actual failure. */
824 RETURN_FAIL("write() failed");
827 bytes_written += result;
831 RETURN_INT(bytes_written);
835 SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
836 const void *buf, size_t count)
838 TRACE("%p, %p, %d", port, buf, count);
843 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
845 DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
852 BYTE *ptr = (BYTE *) buf;
854 /* Check whether previous write is complete. */
856 if (HasOverlappedIoCompleted(&port->write_ovl)) {
857 DEBUG("Previous write completed");
860 DEBUG("Previous write not complete");
861 /* Can't take a new write until the previous one finishes. */
867 port->timeouts.WriteTotalTimeoutConstant = 0;
868 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
869 RETURN_FAIL("SetCommTimeouts() failed");
872 * Keep writing data until the OS has to actually start an async IO
873 * for it. At that point we know the buffer is full.
875 while (written < count) {
876 /* Copy first byte of user buffer. */
877 port->pending_byte = *ptr++;
879 /* Start asynchronous write. */
880 if (WriteFile(port->hdl, &port->pending_byte, 1, NULL, &port->write_ovl) == 0) {
881 if (GetLastError() == ERROR_IO_PENDING) {
882 if (HasOverlappedIoCompleted(&port->write_ovl)) {
883 DEBUG("Asynchronous write completed immediately");
888 DEBUG("Asynchronous write running");
890 RETURN_INT(++written);
893 /* Actual failure of some kind. */
894 RETURN_FAIL("WriteFile() failed");
897 DEBUG("Single byte written immediately");
902 DEBUG("All bytes written immediately");
906 /* Returns the number of bytes written, or -1 upon failure. */
907 ssize_t written = write(port->fd, buf, count);
910 RETURN_FAIL("write() failed");
916 SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
917 size_t count, unsigned int timeout_ms)
919 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
924 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
927 DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms",
928 count, port->name, timeout_ms);
930 DEBUG_FMT("Reading %d bytes from port %s, no timeout",
937 DWORD bytes_read = 0;
938 DWORD bytes_remaining;
942 port->timeouts.ReadIntervalTimeout = 0;
943 port->timeouts.ReadTotalTimeoutConstant = timeout_ms;
944 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
945 RETURN_FAIL("SetCommTimeouts() failed");
948 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0) {
949 if (GetLastError() == ERROR_IO_PENDING) {
950 DEBUG("Waiting for read to complete");
951 GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE);
952 DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
954 RETURN_FAIL("ReadFile() failed");
957 DEBUG("Read completed immediately");
961 ret = sp_input_waiting(port);
966 bytes_remaining = ret;
968 /* Restart wait operation if buffer was emptied. */
969 if (bytes_read > 0 && bytes_remaining == 0)
970 TRY(restart_wait(port));
972 RETURN_INT(bytes_read);
975 size_t bytes_read = 0;
976 unsigned char *ptr = (unsigned char *) buf;
977 struct timeval start, delta, now, end = {0, 0};
982 /* Get time at start of operation. */
983 gettimeofday(&start, NULL);
984 /* Define duration of timeout. */
985 delta.tv_sec = timeout_ms / 1000;
986 delta.tv_usec = (timeout_ms % 1000) * 1000;
987 /* Calculate time at which we should give up. */
988 timeradd(&start, &delta, &end);
991 /* Loop until we have the requested number of bytes. */
992 while (bytes_read < count) {
993 /* Wait until data is available. */
995 FD_SET(port->fd, &fds);
997 gettimeofday(&now, NULL);
998 if (timercmp(&now, &end, >))
999 /* Timeout has expired. */
1000 RETURN_INT(bytes_read);
1001 timersub(&end, &now, &delta);
1003 result = select(port->fd + 1, &fds, NULL, NULL, timeout_ms ? &delta : NULL);
1005 if (errno == EINTR) {
1006 DEBUG("select() call was interrupted, repeating");
1009 RETURN_FAIL("select() failed");
1011 } else if (result == 0) {
1012 DEBUG("Read timed out");
1013 RETURN_INT(bytes_read);
1017 result = read(port->fd, ptr, count - bytes_read);
1020 if (errno == EAGAIN)
1021 /* This shouldn't happen because we did a select() first, but handle anyway. */
1024 /* This is an actual failure. */
1025 RETURN_FAIL("read() failed");
1028 bytes_read += result;
1032 RETURN_INT(bytes_read);
1036 SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
1039 TRACE("%p, %p, %d", port, buf, count);
1044 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1046 DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
1050 DWORD bytes_remaining;
1054 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1055 port->timeouts.ReadTotalTimeoutConstant = 0;
1056 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1057 RETURN_FAIL("SetCommTimeouts() failed");
1060 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
1061 RETURN_FAIL("ReadFile() failed");
1063 /* Get number of bytes read. */
1064 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1065 RETURN_FAIL("GetOverlappedResult() failed");
1067 ret = sp_input_waiting(port);
1070 RETURN_CODEVAL(ret);
1072 bytes_remaining = ret;
1074 /* Restart wait operation if buffer was emptied. */
1075 if (bytes_read > 0 && bytes_remaining == 0)
1076 TRY(restart_wait(port));
1078 RETURN_INT(bytes_read);
1082 /* Returns the number of bytes read, or -1 upon failure. */
1083 if ((bytes_read = read(port->fd, buf, count)) < 0) {
1084 if (errno == EAGAIN)
1085 /* No bytes available. */
1088 /* This is an actual failure. */
1089 RETURN_FAIL("read() failed");
1091 RETURN_INT(bytes_read);
1095 SP_API enum sp_return sp_input_waiting(struct sp_port *port)
1101 DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
1107 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1108 RETURN_FAIL("ClearCommError() failed");
1109 RETURN_INT(comstat.cbInQue);
1112 if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1113 RETURN_FAIL("TIOCINQ ioctl failed");
1114 RETURN_INT(bytes_waiting);
1118 SP_API enum sp_return sp_output_waiting(struct sp_port *port)
1124 DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
1130 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1131 RETURN_FAIL("ClearCommError() failed");
1132 RETURN_INT(comstat.cbOutQue);
1135 if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1136 RETURN_FAIL("TIOCOUTQ ioctl failed");
1137 RETURN_INT(bytes_waiting);
1141 SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
1143 struct sp_event_set *result;
1145 TRACE("%p", result_ptr);
1148 RETURN_ERROR(SP_ERR_ARG, "Null result");
1152 if (!(result = malloc(sizeof(struct sp_event_set))))
1153 RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
1155 memset(result, 0, sizeof(struct sp_event_set));
1157 *result_ptr = result;
1162 static enum sp_return add_handle(struct sp_event_set *event_set,
1163 event_handle handle, enum sp_event mask)
1166 enum sp_event *new_masks;
1168 TRACE("%p, %d, %d", event_set, handle, mask);
1170 if (!(new_handles = realloc(event_set->handles,
1171 sizeof(event_handle) * (event_set->count + 1))))
1172 RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed");
1174 event_set->handles = new_handles;
1176 if (!(new_masks = realloc(event_set->masks,
1177 sizeof(enum sp_event) * (event_set->count + 1))))
1178 RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed");
1180 event_set->masks = new_masks;
1182 ((event_handle *) event_set->handles)[event_set->count] = handle;
1183 event_set->masks[event_set->count] = mask;
1190 SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1191 const struct sp_port *port, enum sp_event mask)
1193 TRACE("%p, %p, %d", event_set, port, mask);
1196 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1199 RETURN_ERROR(SP_ERR_ARG, "Null port");
1201 if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
1202 RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
1208 enum sp_event handle_mask;
1209 if ((handle_mask = mask & SP_EVENT_TX_READY))
1210 TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
1211 if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
1212 TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
1214 TRY(add_handle(event_set, port->fd, mask));
1220 SP_API void sp_free_event_set(struct sp_event_set *event_set)
1222 TRACE("%p", event_set);
1225 DEBUG("Null event set");
1229 DEBUG("Freeing event set");
1231 if (event_set->handles)
1232 free(event_set->handles);
1233 if (event_set->masks)
1234 free(event_set->masks);
1241 SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
1242 unsigned int timeout_ms)
1244 TRACE("%p, %d", event_set, timeout_ms);
1247 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1250 if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
1251 timeout_ms ? timeout_ms : INFINITE) == WAIT_FAILED)
1252 RETURN_FAIL("WaitForMultipleObjects() failed");
1256 struct timeval start, delta, now, end = {0, 0};
1257 int result, timeout_remaining_ms;
1258 struct pollfd *pollfds;
1261 if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
1262 RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
1264 for (i = 0; i < event_set->count; i++) {
1265 pollfds[i].fd = ((int *) event_set->handles)[i];
1266 pollfds[i].events = 0;
1267 pollfds[i].revents = 0;
1268 if (event_set->masks[i] & SP_EVENT_RX_READY)
1269 pollfds[i].events |= POLLIN;
1270 if (event_set->masks[i] & SP_EVENT_TX_READY)
1271 pollfds[i].events |= POLLOUT;
1272 if (event_set->masks[i] & SP_EVENT_ERROR)
1273 pollfds[i].events |= POLLERR;
1277 /* Get time at start of operation. */
1278 gettimeofday(&start, NULL);
1279 /* Define duration of timeout. */
1280 delta.tv_sec = timeout_ms / 1000;
1281 delta.tv_usec = (timeout_ms % 1000) * 1000;
1282 /* Calculate time at which we should give up. */
1283 timeradd(&start, &delta, &end);
1286 /* Loop until an event occurs. */
1289 gettimeofday(&now, NULL);
1290 if (timercmp(&now, &end, >)) {
1291 DEBUG("Wait timed out");
1294 timersub(&end, &now, &delta);
1295 timeout_remaining_ms = delta.tv_sec * 1000 + delta.tv_usec / 1000;
1298 result = poll(pollfds, event_set->count, timeout_ms ? timeout_remaining_ms : -1);
1301 if (errno == EINTR) {
1302 DEBUG("poll() call was interrupted, repeating");
1306 RETURN_FAIL("poll() failed");
1308 } else if (result == 0) {
1309 DEBUG("poll() timed out");
1312 DEBUG("poll() completed");
1322 #ifdef USE_TERMIOS_SPEED
1323 static enum sp_return get_baudrate(int fd, int *baudrate)
1327 TRACE("%d, %p", fd, baudrate);
1329 DEBUG("Getting baud rate");
1331 if (!(data = malloc(get_termios_size())))
1332 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1334 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1336 RETURN_FAIL("Getting termios failed");
1339 *baudrate = get_termios_speed(data);
1346 static enum sp_return set_baudrate(int fd, int baudrate)
1350 TRACE("%d, %d", fd, baudrate);
1352 DEBUG("Getting baud rate");
1354 if (!(data = malloc(get_termios_size())))
1355 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1357 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1359 RETURN_FAIL("Getting termios failed");
1362 DEBUG("Setting baud rate");
1364 set_termios_speed(data, baudrate);
1366 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1368 RETURN_FAIL("Setting termios failed");
1375 #endif /* USE_TERMIOS_SPEED */
1378 static enum sp_return get_flow(int fd, struct port_data *data)
1382 TRACE("%d, %p", fd, data);
1384 DEBUG("Getting advanced flow control");
1386 if (!(termx = malloc(get_termiox_size())))
1387 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1389 if (ioctl(fd, TCGETX, termx) < 0) {
1391 RETURN_FAIL("Getting termiox failed");
1394 get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
1395 &data->dtr_flow, &data->dsr_flow);
1402 static enum sp_return set_flow(int fd, struct port_data *data)
1406 TRACE("%d, %p", fd, data);
1408 DEBUG("Getting advanced flow control");
1410 if (!(termx = malloc(get_termiox_size())))
1411 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1413 if (ioctl(fd, TCGETX, termx) < 0) {
1415 RETURN_FAIL("Getting termiox failed");
1418 DEBUG("Setting advanced flow control");
1420 set_termiox_flow(termx, data->rts_flow, data->cts_flow,
1421 data->dtr_flow, data->dsr_flow);
1423 if (ioctl(fd, TCSETX, termx) < 0) {
1425 RETURN_FAIL("Setting termiox failed");
1432 #endif /* USE_TERMIOX */
1434 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1435 struct sp_port_config *config)
1439 TRACE("%p, %p, %p", port, data, config);
1441 DEBUG_FMT("Getting configuration for port %s", port->name);
1444 if (!GetCommState(port->hdl, &data->dcb))
1445 RETURN_FAIL("GetCommState() failed");
1447 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1448 if (data->dcb.BaudRate == std_baudrates[i].index) {
1449 config->baudrate = std_baudrates[i].value;
1454 if (i == NUM_STD_BAUDRATES)
1455 /* BaudRate field can be either an index or a custom baud rate. */
1456 config->baudrate = data->dcb.BaudRate;
1458 config->bits = data->dcb.ByteSize;
1460 if (data->dcb.fParity)
1461 switch (data->dcb.Parity) {
1463 config->parity = SP_PARITY_NONE;
1466 config->parity = SP_PARITY_ODD;
1469 config->parity = SP_PARITY_EVEN;
1472 config->parity = SP_PARITY_MARK;
1475 config->parity = SP_PARITY_SPACE;
1478 config->parity = -1;
1481 config->parity = SP_PARITY_NONE;
1483 switch (data->dcb.StopBits) {
1485 config->stopbits = 1;
1488 config->stopbits = 2;
1491 config->stopbits = -1;
1494 switch (data->dcb.fRtsControl) {
1495 case RTS_CONTROL_DISABLE:
1496 config->rts = SP_RTS_OFF;
1498 case RTS_CONTROL_ENABLE:
1499 config->rts = SP_RTS_ON;
1501 case RTS_CONTROL_HANDSHAKE:
1502 config->rts = SP_RTS_FLOW_CONTROL;
1508 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1510 switch (data->dcb.fDtrControl) {
1511 case DTR_CONTROL_DISABLE:
1512 config->dtr = SP_DTR_OFF;
1514 case DTR_CONTROL_ENABLE:
1515 config->dtr = SP_DTR_ON;
1517 case DTR_CONTROL_HANDSHAKE:
1518 config->dtr = SP_DTR_FLOW_CONTROL;
1524 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1526 if (data->dcb.fInX) {
1527 if (data->dcb.fOutX)
1528 config->xon_xoff = SP_XONXOFF_INOUT;
1530 config->xon_xoff = SP_XONXOFF_IN;
1532 if (data->dcb.fOutX)
1533 config->xon_xoff = SP_XONXOFF_OUT;
1535 config->xon_xoff = SP_XONXOFF_DISABLED;
1540 if (tcgetattr(port->fd, &data->term) < 0)
1541 RETURN_FAIL("tcgetattr() failed");
1543 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1544 RETURN_FAIL("TIOCMGET ioctl failed");
1547 int ret = get_flow(port->fd, data);
1549 if (ret == SP_ERR_FAIL && errno == EINVAL)
1550 data->termiox_supported = 0;
1552 RETURN_CODEVAL(ret);
1554 data->termiox_supported = 1;
1556 data->termiox_supported = 0;
1559 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1560 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1561 config->baudrate = std_baudrates[i].value;
1566 if (i == NUM_STD_BAUDRATES) {
1568 config->baudrate = (int)data->term.c_ispeed;
1569 #elif defined(USE_TERMIOS_SPEED)
1570 TRY(get_baudrate(port->fd, &config->baudrate));
1572 config->baudrate = -1;
1576 switch (data->term.c_cflag & CSIZE) {
1593 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1594 config->parity = SP_PARITY_NONE;
1595 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1596 config->parity = -1;
1598 else if (data->term.c_cflag & CMSPAR)
1599 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1602 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1604 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1606 if (data->term.c_cflag & CRTSCTS) {
1607 config->rts = SP_RTS_FLOW_CONTROL;
1608 config->cts = SP_CTS_FLOW_CONTROL;
1610 if (data->termiox_supported && data->rts_flow)
1611 config->rts = SP_RTS_FLOW_CONTROL;
1613 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1615 config->cts = (data->termiox_supported && data->cts_flow) ?
1616 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1619 if (data->termiox_supported && data->dtr_flow)
1620 config->dtr = SP_DTR_FLOW_CONTROL;
1622 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1624 config->dsr = (data->termiox_supported && data->dsr_flow) ?
1625 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1627 if (data->term.c_iflag & IXOFF) {
1628 if (data->term.c_iflag & IXON)
1629 config->xon_xoff = SP_XONXOFF_INOUT;
1631 config->xon_xoff = SP_XONXOFF_IN;
1633 if (data->term.c_iflag & IXON)
1634 config->xon_xoff = SP_XONXOFF_OUT;
1636 config->xon_xoff = SP_XONXOFF_DISABLED;
1643 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1644 const struct sp_port_config *config)
1648 BAUD_TYPE baud_nonstd;
1652 #ifdef USE_TERMIOS_SPEED
1653 int baud_nonstd = 0;
1656 TRACE("%p, %p, %p", port, data, config);
1658 DEBUG_FMT("Setting configuration for port %s", port->name);
1661 if (config->baudrate >= 0) {
1662 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1663 if (config->baudrate == std_baudrates[i].value) {
1664 data->dcb.BaudRate = std_baudrates[i].index;
1669 if (i == NUM_STD_BAUDRATES)
1670 data->dcb.BaudRate = config->baudrate;
1673 if (config->bits >= 0)
1674 data->dcb.ByteSize = config->bits;
1676 if (config->parity >= 0) {
1677 switch (config->parity) {
1678 case SP_PARITY_NONE:
1679 data->dcb.Parity = NOPARITY;
1682 data->dcb.Parity = ODDPARITY;
1684 case SP_PARITY_EVEN:
1685 data->dcb.Parity = EVENPARITY;
1687 case SP_PARITY_MARK:
1688 data->dcb.Parity = MARKPARITY;
1690 case SP_PARITY_SPACE:
1691 data->dcb.Parity = SPACEPARITY;
1694 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1698 if (config->stopbits >= 0) {
1699 switch (config->stopbits) {
1700 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1702 data->dcb.StopBits = ONESTOPBIT;
1705 data->dcb.StopBits = TWOSTOPBITS;
1708 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1712 if (config->rts >= 0) {
1713 switch (config->rts) {
1715 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1718 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1720 case SP_RTS_FLOW_CONTROL:
1721 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1724 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1728 if (config->cts >= 0) {
1729 switch (config->cts) {
1731 data->dcb.fOutxCtsFlow = FALSE;
1733 case SP_CTS_FLOW_CONTROL:
1734 data->dcb.fOutxCtsFlow = TRUE;
1737 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1741 if (config->dtr >= 0) {
1742 switch (config->dtr) {
1744 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1747 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1749 case SP_DTR_FLOW_CONTROL:
1750 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1753 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1757 if (config->dsr >= 0) {
1758 switch (config->dsr) {
1760 data->dcb.fOutxDsrFlow = FALSE;
1762 case SP_DSR_FLOW_CONTROL:
1763 data->dcb.fOutxDsrFlow = TRUE;
1766 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1770 if (config->xon_xoff >= 0) {
1771 switch (config->xon_xoff) {
1772 case SP_XONXOFF_DISABLED:
1773 data->dcb.fInX = FALSE;
1774 data->dcb.fOutX = FALSE;
1777 data->dcb.fInX = TRUE;
1778 data->dcb.fOutX = FALSE;
1780 case SP_XONXOFF_OUT:
1781 data->dcb.fInX = FALSE;
1782 data->dcb.fOutX = TRUE;
1784 case SP_XONXOFF_INOUT:
1785 data->dcb.fInX = TRUE;
1786 data->dcb.fOutX = TRUE;
1789 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1793 if (!SetCommState(port->hdl, &data->dcb))
1794 RETURN_FAIL("SetCommState() failed");
1800 if (config->baudrate >= 0) {
1801 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1802 if (config->baudrate == std_baudrates[i].value) {
1803 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1804 RETURN_FAIL("cfsetospeed() failed");
1806 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1807 RETURN_FAIL("cfsetispeed() failed");
1812 /* Non-standard baud rate */
1813 if (i == NUM_STD_BAUDRATES) {
1815 /* Set "dummy" baud rate. */
1816 if (cfsetspeed(&data->term, B9600) < 0)
1817 RETURN_FAIL("cfsetspeed() failed");
1818 baud_nonstd = config->baudrate;
1819 #elif defined(USE_TERMIOS_SPEED)
1822 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
1827 if (config->bits >= 0) {
1828 data->term.c_cflag &= ~CSIZE;
1829 switch (config->bits) {
1831 data->term.c_cflag |= CS8;
1834 data->term.c_cflag |= CS7;
1837 data->term.c_cflag |= CS6;
1840 data->term.c_cflag |= CS5;
1843 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
1847 if (config->parity >= 0) {
1848 data->term.c_iflag &= ~IGNPAR;
1849 data->term.c_cflag &= ~(PARENB | PARODD);
1851 data->term.c_cflag &= ~CMSPAR;
1853 switch (config->parity) {
1854 case SP_PARITY_NONE:
1855 data->term.c_iflag |= IGNPAR;
1857 case SP_PARITY_EVEN:
1858 data->term.c_cflag |= PARENB;
1861 data->term.c_cflag |= PARENB | PARODD;
1864 case SP_PARITY_MARK:
1865 data->term.c_cflag |= PARENB | PARODD;
1866 data->term.c_cflag |= CMSPAR;
1868 case SP_PARITY_SPACE:
1869 data->term.c_cflag |= PARENB;
1870 data->term.c_cflag |= CMSPAR;
1873 case SP_PARITY_MARK:
1874 case SP_PARITY_SPACE:
1875 RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
1878 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1882 if (config->stopbits >= 0) {
1883 data->term.c_cflag &= ~CSTOPB;
1884 switch (config->stopbits) {
1886 data->term.c_cflag &= ~CSTOPB;
1889 data->term.c_cflag |= CSTOPB;
1892 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
1896 if (config->rts >= 0 || config->cts >= 0) {
1897 if (data->termiox_supported) {
1898 data->rts_flow = data->cts_flow = 0;
1899 switch (config->rts) {
1902 controlbits = TIOCM_RTS;
1903 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1904 RETURN_FAIL("Setting RTS signal level failed");
1906 case SP_RTS_FLOW_CONTROL:
1912 if (config->cts == SP_CTS_FLOW_CONTROL)
1915 if (data->rts_flow && data->cts_flow)
1916 data->term.c_iflag |= CRTSCTS;
1918 data->term.c_iflag &= ~CRTSCTS;
1920 /* Asymmetric use of RTS/CTS not supported. */
1921 if (data->term.c_iflag & CRTSCTS) {
1922 /* Flow control can only be disabled for both RTS & CTS together. */
1923 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
1924 if (config->cts != SP_CTS_IGNORE)
1925 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1927 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
1928 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
1929 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
1932 /* Flow control can only be enabled for both RTS & CTS together. */
1933 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
1934 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
1935 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
1938 if (config->rts >= 0) {
1939 if (config->rts == SP_RTS_FLOW_CONTROL) {
1940 data->term.c_iflag |= CRTSCTS;
1942 controlbits = TIOCM_RTS;
1943 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
1945 RETURN_FAIL("Setting RTS signal level failed");
1951 if (config->dtr >= 0 || config->dsr >= 0) {
1952 if (data->termiox_supported) {
1953 data->dtr_flow = data->dsr_flow = 0;
1954 switch (config->dtr) {
1957 controlbits = TIOCM_DTR;
1958 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
1959 RETURN_FAIL("Setting DTR signal level failed");
1961 case SP_DTR_FLOW_CONTROL:
1967 if (config->dsr == SP_DSR_FLOW_CONTROL)
1970 /* DTR/DSR flow control not supported. */
1971 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
1972 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
1974 if (config->dtr >= 0) {
1975 controlbits = TIOCM_DTR;
1976 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
1978 RETURN_FAIL("Setting DTR signal level failed");
1983 if (config->xon_xoff >= 0) {
1984 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
1985 switch (config->xon_xoff) {
1986 case SP_XONXOFF_DISABLED:
1989 data->term.c_iflag |= IXOFF;
1991 case SP_XONXOFF_OUT:
1992 data->term.c_iflag |= IXON | IXANY;
1994 case SP_XONXOFF_INOUT:
1995 data->term.c_iflag |= IXON | IXOFF | IXANY;
1998 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2002 if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
2003 RETURN_FAIL("tcsetattr() failed");
2006 if (baud_nonstd != B0) {
2007 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
2008 RETURN_FAIL("IOSSIOSPEED ioctl failed");
2010 * Set baud rates in data->term to correct, but incompatible
2011 * with tcsetattr() value, same as delivered by tcgetattr().
2013 if (cfsetspeed(&data->term, baud_nonstd) < 0)
2014 RETURN_FAIL("cfsetspeed() failed");
2016 #elif defined(__linux__)
2017 #ifdef USE_TERMIOS_SPEED
2019 TRY(set_baudrate(port->fd, config->baudrate));
2022 if (data->termiox_supported)
2023 TRY(set_flow(port->fd, data));
2027 #endif /* !_WIN32 */
2032 SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
2034 struct sp_port_config *config;
2036 TRACE("%p", config_ptr);
2039 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2043 if (!(config = malloc(sizeof(struct sp_port_config))))
2044 RETURN_ERROR(SP_ERR_MEM, "Config malloc failed");
2046 config->baudrate = -1;
2048 config->parity = -1;
2049 config->stopbits = -1;
2055 *config_ptr = config;
2060 SP_API void sp_free_config(struct sp_port_config *config)
2062 TRACE("%p", config);
2065 DEBUG("Null config");
2072 SP_API enum sp_return sp_get_config(struct sp_port *port,
2073 struct sp_port_config *config)
2075 struct port_data data;
2077 TRACE("%p, %p", port, config);
2082 RETURN_ERROR(SP_ERR_ARG, "Null config");
2084 TRY(get_config(port, &data, config));
2089 SP_API enum sp_return sp_set_config(struct sp_port *port,
2090 const struct sp_port_config *config)
2092 struct port_data data;
2093 struct sp_port_config prev_config;
2095 TRACE("%p, %p", port, config);
2100 RETURN_ERROR(SP_ERR_ARG, "Null config");
2102 TRY(get_config(port, &data, &prev_config));
2103 TRY(set_config(port, &data, config));
2108 #define CREATE_ACCESSORS(x, type) \
2109 SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2110 struct port_data data; \
2111 struct sp_port_config config; \
2112 TRACE("%p, %d", port, x); \
2113 CHECK_OPEN_PORT(); \
2114 TRY(get_config(port, &data, &config)); \
2116 TRY(set_config(port, &data, &config)); \
2119 SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \
2121 TRACE("%p, %p", config, x); \
2123 RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); \
2125 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2129 SP_API enum sp_return sp_set_config_##x(struct sp_port_config *config, \
2131 TRACE("%p, %d", config, x); \
2133 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2138 CREATE_ACCESSORS(baudrate, int)
2139 CREATE_ACCESSORS(bits, int)
2140 CREATE_ACCESSORS(parity, enum sp_parity)
2141 CREATE_ACCESSORS(stopbits, int)
2142 CREATE_ACCESSORS(rts, enum sp_rts)
2143 CREATE_ACCESSORS(cts, enum sp_cts)
2144 CREATE_ACCESSORS(dtr, enum sp_dtr)
2145 CREATE_ACCESSORS(dsr, enum sp_dsr)
2146 CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2148 SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config,
2149 enum sp_flowcontrol flowcontrol)
2152 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2154 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2155 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2157 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2158 config->xon_xoff = SP_XONXOFF_INOUT;
2160 config->xon_xoff = SP_XONXOFF_DISABLED;
2162 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2163 config->rts = SP_RTS_FLOW_CONTROL;
2164 config->cts = SP_CTS_FLOW_CONTROL;
2166 if (config->rts == SP_RTS_FLOW_CONTROL)
2167 config->rts = SP_RTS_ON;
2168 config->cts = SP_CTS_IGNORE;
2171 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2172 config->dtr = SP_DTR_FLOW_CONTROL;
2173 config->dsr = SP_DSR_FLOW_CONTROL;
2175 if (config->dtr == SP_DTR_FLOW_CONTROL)
2176 config->dtr = SP_DTR_ON;
2177 config->dsr = SP_DSR_IGNORE;
2183 SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port,
2184 enum sp_flowcontrol flowcontrol)
2186 struct port_data data;
2187 struct sp_port_config config;
2189 TRACE("%p, %d", port, flowcontrol);
2193 TRY(get_config(port, &data, &config));
2195 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2197 TRY(set_config(port, &data, &config));
2202 SP_API enum sp_return sp_get_signals(struct sp_port *port,
2203 enum sp_signal *signals)
2205 TRACE("%p, %p", port, signals);
2210 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2212 DEBUG_FMT("Getting control signals for port %s", port->name);
2217 if (GetCommModemStatus(port->hdl, &bits) == 0)
2218 RETURN_FAIL("GetCommModemStatus() failed");
2219 if (bits & MS_CTS_ON)
2220 *signals |= SP_SIG_CTS;
2221 if (bits & MS_DSR_ON)
2222 *signals |= SP_SIG_DSR;
2223 if (bits & MS_RLSD_ON)
2224 *signals |= SP_SIG_DCD;
2225 if (bits & MS_RING_ON)
2226 *signals |= SP_SIG_RI;
2229 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2230 RETURN_FAIL("TIOCMGET ioctl failed");
2231 if (bits & TIOCM_CTS)
2232 *signals |= SP_SIG_CTS;
2233 if (bits & TIOCM_DSR)
2234 *signals |= SP_SIG_DSR;
2235 if (bits & TIOCM_CAR)
2236 *signals |= SP_SIG_DCD;
2237 if (bits & TIOCM_RNG)
2238 *signals |= SP_SIG_RI;
2243 SP_API enum sp_return sp_start_break(struct sp_port *port)
2249 if (SetCommBreak(port->hdl) == 0)
2250 RETURN_FAIL("SetCommBreak() failed");
2252 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2253 RETURN_FAIL("TIOCSBRK ioctl failed");
2259 SP_API enum sp_return sp_end_break(struct sp_port *port)
2265 if (ClearCommBreak(port->hdl) == 0)
2266 RETURN_FAIL("ClearCommBreak() failed");
2268 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2269 RETURN_FAIL("TIOCCBRK ioctl failed");
2275 SP_API int sp_last_error_code(void)
2279 RETURN_INT(GetLastError());
2285 SP_API char *sp_last_error_message(void)
2291 DWORD error = GetLastError();
2294 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2295 FORMAT_MESSAGE_FROM_SYSTEM |
2296 FORMAT_MESSAGE_IGNORE_INSERTS,
2299 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2303 RETURN_STRING(message);
2305 RETURN_STRING(strerror(errno));
2309 SP_API void sp_free_error_message(char *message)
2311 TRACE("%s", message);
2322 SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...))
2324 TRACE("%p", handler);
2326 sp_debug_handler = handler;
2331 SP_API void sp_default_debug_handler(const char *format, ...)
2334 va_start(args, format);
2335 if (getenv("LIBSERIALPORT_DEBUG")) {
2336 fputs("sp: ", stderr);
2337 vfprintf(stderr, format, args);
2342 SP_API int sp_get_major_package_version(void)
2344 return SP_PACKAGE_VERSION_MAJOR;
2347 SP_API int sp_get_minor_package_version(void)
2349 return SP_PACKAGE_VERSION_MINOR;
2352 SP_API int sp_get_micro_package_version(void)
2354 return SP_PACKAGE_VERSION_MICRO;
2357 SP_API const char *sp_get_package_version_string(void)
2359 return SP_PACKAGE_VERSION_STRING;
2362 SP_API int sp_get_current_lib_version(void)
2364 return SP_LIB_VERSION_CURRENT;
2367 SP_API int sp_get_revision_lib_version(void)
2369 return SP_LIB_VERSION_REVISION;
2372 SP_API int sp_get_age_lib_version(void)
2374 return SP_LIB_VERSION_AGE;
2377 SP_API const char *sp_get_lib_version_string(void)
2379 return SP_LIB_VERSION_STRING;