2 * This file is part of the libserialport project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2010-2015 Uwe Hermann <uwe@hermann-uwe.de>
6 * Copyright (C) 2013-2015 Martin Ling <martin-libserialport@earth.li>
7 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
8 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License as
12 * published by the Free Software Foundation, either version 3 of the
13 * License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "libserialport.h"
26 #include "libserialport_internal.h"
28 static const struct std_baudrate std_baudrates[] = {
31 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
32 * have documented CBR_* macros.
34 BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
35 BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
36 BAUD(115200), BAUD(128000), BAUD(256000),
38 BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
39 BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
40 BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
42 #if !defined(__APPLE__) && !defined(__OpenBSD__)
48 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
50 void (*sp_debug_handler)(const char *format, ...) = sp_default_debug_handler;
52 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
53 struct sp_port_config *config);
55 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
56 const struct sp_port_config *config);
58 SP_API enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
61 #ifndef NO_PORT_METADATA
66 TRACE("%s, %p", portname, port_ptr);
69 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
74 RETURN_ERROR(SP_ERR_ARG, "Null port name");
76 DEBUG_FMT("Building structure for port %s", portname);
78 #if !defined(_WIN32) && defined(HAVE_REALPATH)
80 * get_port_details() below tries to be too smart and figure out
81 * some transport properties from the port name which breaks with
82 * symlinks. Therefore we canonicalize the portname first.
84 char pathbuf[PATH_MAX + 1];
85 char *res = realpath(portname, pathbuf);
87 RETURN_ERROR(SP_ERR_ARG, "Could not retrieve realpath behind port name");
92 if (!(port = malloc(sizeof(struct sp_port))))
93 RETURN_ERROR(SP_ERR_MEM, "Port structure malloc failed");
95 len = strlen(portname) + 1;
97 if (!(port->name = malloc(len))) {
99 RETURN_ERROR(SP_ERR_MEM, "Port name malloc failed");
102 memcpy(port->name, portname, len);
105 port->usb_path = NULL;
106 port->hdl = INVALID_HANDLE_VALUE;
107 port->write_buf = NULL;
108 port->write_buf_size = 0;
113 port->description = NULL;
114 port->transport = SP_TRANSPORT_NATIVE;
116 port->usb_address = -1;
119 port->usb_manufacturer = NULL;
120 port->usb_product = NULL;
121 port->usb_serial = NULL;
122 port->bluetooth_address = NULL;
124 #ifndef NO_PORT_METADATA
125 if ((ret = get_port_details(port)) != SP_OK) {
136 SP_API char *sp_get_port_name(const struct sp_port *port)
143 RETURN_STRING(port->name);
146 SP_API char *sp_get_port_description(const struct sp_port *port)
150 if (!port || !port->description)
153 RETURN_STRING(port->description);
156 SP_API enum sp_transport sp_get_port_transport(const struct sp_port *port)
161 RETURN_ERROR(SP_ERR_ARG, "Null port");
163 RETURN_INT(port->transport);
166 SP_API enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
167 int *usb_bus,int *usb_address)
172 RETURN_ERROR(SP_ERR_ARG, "Null port");
173 if (port->transport != SP_TRANSPORT_USB)
174 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
175 if (port->usb_bus < 0 || port->usb_address < 0)
176 RETURN_ERROR(SP_ERR_SUPP, "Bus and address values are not available");
179 *usb_bus = port->usb_bus;
181 *usb_address = port->usb_address;
186 SP_API enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port,
187 int *usb_vid, int *usb_pid)
192 RETURN_ERROR(SP_ERR_ARG, "Null port");
193 if (port->transport != SP_TRANSPORT_USB)
194 RETURN_ERROR(SP_ERR_ARG, "Port does not use USB transport");
195 if (port->usb_vid < 0 || port->usb_pid < 0)
196 RETURN_ERROR(SP_ERR_SUPP, "VID:PID values are not available");
199 *usb_vid = port->usb_vid;
201 *usb_pid = port->usb_pid;
206 SP_API char *sp_get_port_usb_manufacturer(const struct sp_port *port)
210 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_manufacturer)
213 RETURN_STRING(port->usb_manufacturer);
216 SP_API char *sp_get_port_usb_product(const struct sp_port *port)
220 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_product)
223 RETURN_STRING(port->usb_product);
226 SP_API char *sp_get_port_usb_serial(const struct sp_port *port)
230 if (!port || port->transport != SP_TRANSPORT_USB || !port->usb_serial)
233 RETURN_STRING(port->usb_serial);
236 SP_API char *sp_get_port_bluetooth_address(const struct sp_port *port)
240 if (!port || port->transport != SP_TRANSPORT_BLUETOOTH
241 || !port->bluetooth_address)
244 RETURN_STRING(port->bluetooth_address);
247 SP_API enum sp_return sp_get_port_handle(const struct sp_port *port,
250 TRACE("%p, %p", port, result_ptr);
253 RETURN_ERROR(SP_ERR_ARG, "Null port");
255 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
258 HANDLE *handle_ptr = result_ptr;
259 *handle_ptr = port->hdl;
261 int *fd_ptr = result_ptr;
268 SP_API enum sp_return sp_copy_port(const struct sp_port *port,
269 struct sp_port **copy_ptr)
271 TRACE("%p, %p", port, copy_ptr);
274 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
279 RETURN_ERROR(SP_ERR_ARG, "Null port");
282 RETURN_ERROR(SP_ERR_ARG, "Null port name");
284 DEBUG("Copying port structure");
286 RETURN_INT(sp_get_port_by_name(port->name, copy_ptr));
289 SP_API void sp_free_port(struct sp_port *port)
298 DEBUG("Freeing port structure");
302 if (port->description)
303 free(port->description);
304 if (port->usb_manufacturer)
305 free(port->usb_manufacturer);
306 if (port->usb_product)
307 free(port->usb_product);
308 if (port->usb_serial)
309 free(port->usb_serial);
310 if (port->bluetooth_address)
311 free(port->bluetooth_address);
314 free(port->usb_path);
316 free(port->write_buf);
324 SP_PRIV struct sp_port **list_append(struct sp_port **list,
325 const char *portname)
330 for (count = 0; list[count]; count++)
332 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
335 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
337 list[count + 1] = NULL;
341 sp_free_port_list(list);
345 SP_API enum sp_return sp_list_ports(struct sp_port ***list_ptr)
347 #ifndef NO_ENUMERATION
348 struct sp_port **list;
352 TRACE("%p", list_ptr);
355 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
359 #ifdef NO_ENUMERATION
360 RETURN_ERROR(SP_ERR_SUPP, "Enumeration not supported on this platform");
362 DEBUG("Enumerating ports");
364 if (!(list = malloc(sizeof(struct sp_port *))))
365 RETURN_ERROR(SP_ERR_MEM, "Port list malloc failed");
369 ret = list_ports(&list);
374 sp_free_port_list(list);
382 SP_API void sp_free_port_list(struct sp_port **list)
393 DEBUG("Freeing port list");
395 for (i = 0; list[i]; i++)
396 sp_free_port(list[i]);
402 #define CHECK_PORT() do { \
404 RETURN_ERROR(SP_ERR_ARG, "Null port"); \
406 RETURN_ERROR(SP_ERR_ARG, "Null port name"); \
409 #define CHECK_PORT_HANDLE() do { \
410 if (port->hdl == INVALID_HANDLE_VALUE) \
411 RETURN_ERROR(SP_ERR_ARG, "Port not open"); \
414 #define CHECK_PORT_HANDLE() do { \
416 RETURN_ERROR(SP_ERR_ARG, "Port not open"); \
419 #define CHECK_OPEN_PORT() do { \
421 CHECK_PORT_HANDLE(); \
425 /** To be called after port receive buffer is emptied. */
426 static enum sp_return restart_wait(struct sp_port *port)
430 if (port->wait_running) {
431 /* Check status of running wait operation. */
432 if (GetOverlappedResult(port->hdl, &port->wait_ovl,
433 &wait_result, FALSE)) {
434 DEBUG("Previous wait completed");
435 port->wait_running = FALSE;
436 } else if (GetLastError() == ERROR_IO_INCOMPLETE) {
437 DEBUG("Previous wait still running");
440 RETURN_FAIL("GetOverlappedResult() failed");
444 if (!port->wait_running) {
445 /* Start new wait operation. */
446 if (WaitCommEvent(port->hdl, &port->events,
448 DEBUG("New wait returned, events already pending");
449 } else if (GetLastError() == ERROR_IO_PENDING) {
450 DEBUG("New wait running in background");
451 port->wait_running = TRUE;
453 RETURN_FAIL("WaitCommEvent() failed");
461 SP_API enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
463 struct port_data data;
464 struct sp_port_config config;
467 TRACE("%p, 0x%x", port, flags);
471 if (flags > SP_MODE_READ_WRITE)
472 RETURN_ERROR(SP_ERR_ARG, "Invalid flags");
474 DEBUG_FMT("Opening port %s", port->name);
477 DWORD desired_access = 0, flags_and_attributes = 0, errors;
478 char *escaped_port_name;
481 /* Prefix port name with '\\.\' to work with ports above COM9. */
482 if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
483 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
484 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
486 /* Map 'flags' to the OS-specific settings. */
487 flags_and_attributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED;
488 if (flags & SP_MODE_READ)
489 desired_access |= GENERIC_READ;
490 if (flags & SP_MODE_WRITE)
491 desired_access |= GENERIC_WRITE;
493 port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
494 OPEN_EXISTING, flags_and_attributes, 0);
496 free(escaped_port_name);
498 if (port->hdl == INVALID_HANDLE_VALUE)
499 RETURN_FAIL("Port CreateFile() failed");
501 /* All timeouts initially disabled. */
502 port->timeouts.ReadIntervalTimeout = 0;
503 port->timeouts.ReadTotalTimeoutMultiplier = 0;
504 port->timeouts.ReadTotalTimeoutConstant = 0;
505 port->timeouts.WriteTotalTimeoutMultiplier = 0;
506 port->timeouts.WriteTotalTimeoutConstant = 0;
508 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0) {
510 RETURN_FAIL("SetCommTimeouts() failed");
513 /* Prepare OVERLAPPED structures. */
514 #define INIT_OVERLAPPED(ovl) do { \
515 memset(&port->ovl, 0, sizeof(port->ovl)); \
516 port->ovl.hEvent = INVALID_HANDLE_VALUE; \
517 if ((port->ovl.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL)) \
518 == INVALID_HANDLE_VALUE) { \
520 RETURN_FAIL(#ovl "CreateEvent() failed"); \
524 INIT_OVERLAPPED(read_ovl);
525 INIT_OVERLAPPED(write_ovl);
526 INIT_OVERLAPPED(wait_ovl);
528 /* Set event mask for RX and error events. */
529 if (SetCommMask(port->hdl, EV_RXCHAR | EV_ERR) == 0) {
531 RETURN_FAIL("SetCommMask() failed");
534 port->writing = FALSE;
535 port->wait_running = FALSE;
537 ret = restart_wait(port);
544 int flags_local = O_NONBLOCK | O_NOCTTY | O_CLOEXEC;
546 /* Map 'flags' to the OS-specific settings. */
547 if ((flags & SP_MODE_READ_WRITE) == SP_MODE_READ_WRITE)
548 flags_local |= O_RDWR;
549 else if (flags & SP_MODE_READ)
550 flags_local |= O_RDONLY;
551 else if (flags & SP_MODE_WRITE)
552 flags_local |= O_WRONLY;
554 if ((port->fd = open(port->name, flags_local)) < 0)
555 RETURN_FAIL("open() failed");
558 ret = get_config(port, &data, &config);
565 /* Set sane port settings. */
567 data.dcb.fBinary = TRUE;
568 data.dcb.fDsrSensitivity = FALSE;
569 data.dcb.fErrorChar = FALSE;
570 data.dcb.fNull = FALSE;
571 data.dcb.fAbortOnError = FALSE;
573 /* Turn off all fancy termios tricks, give us a raw channel. */
574 data.term.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP | INLCR | IGNCR | ICRNL | IMAXBEL);
576 data.term.c_iflag &= ~IUCLC;
578 data.term.c_oflag &= ~(OPOST | ONLCR | OCRNL | ONOCR | ONLRET);
580 data.term.c_oflag &= ~OLCUC;
583 data.term.c_oflag &= ~NLDLY;
586 data.term.c_oflag &= ~CRDLY;
589 data.term.c_oflag &= ~TABDLY;
592 data.term.c_oflag &= ~BSDLY;
595 data.term.c_oflag &= ~VTDLY;
598 data.term.c_oflag &= ~FFDLY;
601 data.term.c_oflag &= ~OFILL;
603 data.term.c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN);
604 data.term.c_cc[VMIN] = 0;
605 data.term.c_cc[VTIME] = 0;
607 /* Ignore modem status lines; enable receiver; leave control lines alone on close. */
608 data.term.c_cflag |= (CLOCAL | CREAD | HUPCL);
612 if (ClearCommError(port->hdl, &errors, &status) == 0)
613 RETURN_FAIL("ClearCommError() failed");
616 ret = set_config(port, &data, &config);
626 SP_API enum sp_return sp_close(struct sp_port *port)
632 DEBUG_FMT("Closing port %s", port->name);
635 /* Returns non-zero upon success, 0 upon failure. */
636 if (CloseHandle(port->hdl) == 0)
637 RETURN_FAIL("Port CloseHandle() failed");
638 port->hdl = INVALID_HANDLE_VALUE;
640 /* Close event handles for overlapped structures. */
641 #define CLOSE_OVERLAPPED(ovl) do { \
642 if (port->ovl.hEvent != INVALID_HANDLE_VALUE && \
643 CloseHandle(port->ovl.hEvent) == 0) \
644 RETURN_FAIL(# ovl "event CloseHandle() failed"); \
646 CLOSE_OVERLAPPED(read_ovl);
647 CLOSE_OVERLAPPED(write_ovl);
648 CLOSE_OVERLAPPED(wait_ovl);
650 if (port->write_buf) {
651 free(port->write_buf);
652 port->write_buf = NULL;
655 /* Returns 0 upon success, -1 upon failure. */
656 if (close(port->fd) == -1)
657 RETURN_FAIL("close() failed");
664 SP_API enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers)
666 TRACE("%p, 0x%x", port, buffers);
670 if (buffers > SP_BUF_BOTH)
671 RETURN_ERROR(SP_ERR_ARG, "Invalid buffer selection");
673 const char *buffer_names[] = {"no", "input", "output", "both"};
675 DEBUG_FMT("Flushing %s buffers on port %s",
676 buffer_names[buffers], port->name);
680 if (buffers & SP_BUF_INPUT)
681 flags |= PURGE_RXCLEAR;
682 if (buffers & SP_BUF_OUTPUT)
683 flags |= PURGE_TXCLEAR;
685 /* Returns non-zero upon success, 0 upon failure. */
686 if (PurgeComm(port->hdl, flags) == 0)
687 RETURN_FAIL("PurgeComm() failed");
689 if (buffers & SP_BUF_INPUT)
690 TRY(restart_wait(port));
693 if (buffers == SP_BUF_BOTH)
695 else if (buffers == SP_BUF_INPUT)
697 else if (buffers == SP_BUF_OUTPUT)
700 /* Returns 0 upon success, -1 upon failure. */
701 if (tcflush(port->fd, flags) < 0)
702 RETURN_FAIL("tcflush() failed");
707 SP_API enum sp_return sp_drain(struct sp_port *port)
713 DEBUG_FMT("Draining port %s", port->name);
716 /* Returns non-zero upon success, 0 upon failure. */
717 if (FlushFileBuffers(port->hdl) == 0)
718 RETURN_FAIL("FlushFileBuffers() failed");
723 #if defined(__ANDROID__) && (__ANDROID_API__ < 21)
724 /* Android only has tcdrain from platform 21 onwards.
725 * On previous API versions, use the ioctl directly. */
727 result = ioctl(port->fd, TCSBRK, &arg);
729 result = tcdrain(port->fd);
732 if (errno == EINTR) {
733 DEBUG("tcdrain() was interrupted");
736 RETURN_FAIL("tcdrain() failed");
746 static enum sp_return await_write_completion(struct sp_port *port)
752 /* Wait for previous non-blocking write to complete, if any. */
754 DEBUG("Waiting for previous write to complete");
755 result = GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE);
758 RETURN_FAIL("Previous write failed to complete");
759 DEBUG("Previous write completed");
766 SP_API enum sp_return sp_blocking_write(struct sp_port *port, const void *buf,
767 size_t count, unsigned int timeout_ms)
769 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
774 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
777 DEBUG_FMT("Writing %d bytes to port %s, timeout %d ms",
778 count, port->name, timeout_ms);
780 DEBUG_FMT("Writing %d bytes to port %s, no timeout",
787 DWORD remaining_ms, write_size, bytes_written, total_bytes_written = 0;
788 const uint8_t *write_ptr = (uint8_t *) buf;
790 struct timeout timeout;
792 timeout_start(&timeout, timeout_ms);
794 TRY(await_write_completion(port));
796 while (total_bytes_written < count) {
798 if (timeout_check(&timeout))
801 remaining_ms = timeout_remaining_ms(&timeout);
803 if (port->timeouts.WriteTotalTimeoutConstant != remaining_ms) {
804 port->timeouts.WriteTotalTimeoutConstant = remaining_ms;
805 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
806 RETURN_FAIL("SetCommTimeouts() failed");
809 /* Reduce write size if it exceeds the WriteFile limit. */
810 write_size = count - total_bytes_written;
811 if (write_size > WRITEFILE_MAX_SIZE)
812 write_size = WRITEFILE_MAX_SIZE;
816 result = WriteFile(port->hdl, write_ptr, write_size, NULL, &port->write_ovl);
818 timeout_update(&timeout);
821 DEBUG("Write completed immediately");
822 bytes_written = write_size;
823 } else if (GetLastError() == ERROR_IO_PENDING) {
824 DEBUG("Waiting for write to complete");
825 if (GetOverlappedResult(port->hdl, &port->write_ovl, &bytes_written, TRUE) == 0) {
826 if (GetLastError() == ERROR_SEM_TIMEOUT) {
827 DEBUG("Write timed out");
830 RETURN_FAIL("GetOverlappedResult() failed");
833 DEBUG_FMT("Write completed, %d/%d bytes written", bytes_written, write_size);
835 RETURN_FAIL("WriteFile() failed");
838 write_ptr += bytes_written;
839 total_bytes_written += bytes_written;
842 RETURN_INT(total_bytes_written);
844 size_t bytes_written = 0;
845 unsigned char *ptr = (unsigned char *) buf;
846 struct timeout timeout;
850 timeout_start(&timeout, timeout_ms);
853 FD_SET(port->fd, &fds);
855 /* Loop until we have written the requested number of bytes. */
856 while (bytes_written < count) {
858 if (timeout_check(&timeout))
861 result = select(port->fd + 1, NULL, &fds, NULL, timeout_timeval(&timeout));
863 timeout_update(&timeout);
866 if (errno == EINTR) {
867 DEBUG("select() call was interrupted, repeating");
870 RETURN_FAIL("select() failed");
872 } else if (result == 0) {
873 /* Timeout has expired. */
878 result = write(port->fd, ptr, count - bytes_written);
882 /* This shouldn't happen because we did a select() first, but handle anyway. */
885 /* This is an actual failure. */
886 RETURN_FAIL("write() failed");
889 bytes_written += result;
893 if (bytes_written < count)
894 DEBUG("Write timed out");
896 RETURN_INT(bytes_written);
900 SP_API enum sp_return sp_nonblocking_write(struct sp_port *port,
901 const void *buf, size_t count)
903 TRACE("%p, %p, %d", port, buf, count);
908 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
910 DEBUG_FMT("Writing up to %d bytes to port %s", count, port->name);
918 /* Check whether previous write is complete. */
920 if (HasOverlappedIoCompleted(&port->write_ovl)) {
921 DEBUG("Previous write completed");
924 DEBUG("Previous write not complete");
925 /* Can't take a new write until the previous one finishes. */
931 if (port->timeouts.WriteTotalTimeoutConstant != 0) {
932 port->timeouts.WriteTotalTimeoutConstant = 0;
933 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
934 RETURN_FAIL("SetCommTimeouts() failed");
937 /* Reduce count if it exceeds the WriteFile limit. */
938 if (count > WRITEFILE_MAX_SIZE)
939 count = WRITEFILE_MAX_SIZE;
941 /* Copy data to our write buffer. */
942 buf_bytes = min(port->write_buf_size, count);
943 memcpy(port->write_buf, buf, buf_bytes);
945 /* Start asynchronous write. */
946 if (WriteFile(port->hdl, port->write_buf, buf_bytes, NULL, &port->write_ovl) == 0) {
947 if (GetLastError() == ERROR_IO_PENDING) {
948 if ((port->writing = !HasOverlappedIoCompleted(&port->write_ovl)))
949 DEBUG("Asynchronous write completed immediately");
951 DEBUG("Asynchronous write running");
953 /* Actual failure of some kind. */
954 RETURN_FAIL("WriteFile() failed");
958 DEBUG("All bytes written immediately");
960 RETURN_INT(buf_bytes);
962 /* Returns the number of bytes written, or -1 upon failure. */
963 ssize_t written = write(port->fd, buf, count);
967 // Buffer is full, no bytes written.
970 RETURN_FAIL("write() failed");
978 /* Restart wait operation if buffer was emptied. */
979 static enum sp_return restart_wait_if_needed(struct sp_port *port, unsigned int bytes_read)
987 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
988 RETURN_FAIL("ClearCommError() failed");
990 if (comstat.cbInQue == 0)
991 TRY(restart_wait(port));
997 SP_API enum sp_return sp_blocking_read(struct sp_port *port, void *buf,
998 size_t count, unsigned int timeout_ms)
1000 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
1005 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1008 DEBUG_FMT("Reading %d bytes from port %s, timeout %d ms",
1009 count, port->name, timeout_ms);
1011 DEBUG_FMT("Reading %d bytes from port %s, no timeout",
1018 DWORD bytes_read = 0;
1021 if (port->timeouts.ReadIntervalTimeout != 0 ||
1022 port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
1023 port->timeouts.ReadTotalTimeoutConstant != timeout_ms) {
1024 port->timeouts.ReadIntervalTimeout = 0;
1025 port->timeouts.ReadTotalTimeoutMultiplier = 0;
1026 port->timeouts.ReadTotalTimeoutConstant = timeout_ms;
1027 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1028 RETURN_FAIL("SetCommTimeouts() failed");
1032 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl)) {
1033 DEBUG("Read completed immediately");
1035 } else if (GetLastError() == ERROR_IO_PENDING) {
1036 DEBUG("Waiting for read to complete");
1037 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1038 RETURN_FAIL("GetOverlappedResult() failed");
1039 DEBUG_FMT("Read completed, %d/%d bytes read", bytes_read, count);
1041 RETURN_FAIL("ReadFile() failed");
1044 TRY(restart_wait_if_needed(port, bytes_read));
1046 RETURN_INT(bytes_read);
1049 size_t bytes_read = 0;
1050 unsigned char *ptr = (unsigned char *) buf;
1051 struct timeout timeout;
1055 timeout_start(&timeout, timeout_ms);
1058 FD_SET(port->fd, &fds);
1060 /* Loop until we have the requested number of bytes. */
1061 while (bytes_read < count) {
1063 if (timeout_check(&timeout))
1064 /* Timeout has expired. */
1067 result = select(port->fd + 1, &fds, NULL, NULL, timeout_timeval(&timeout));
1069 timeout_update(&timeout);
1072 if (errno == EINTR) {
1073 DEBUG("select() call was interrupted, repeating");
1076 RETURN_FAIL("select() failed");
1078 } else if (result == 0) {
1079 /* Timeout has expired. */
1084 result = read(port->fd, ptr, count - bytes_read);
1087 if (errno == EAGAIN)
1089 * This shouldn't happen because we did a
1090 * select() first, but handle anyway.
1094 /* This is an actual failure. */
1095 RETURN_FAIL("read() failed");
1098 bytes_read += result;
1102 if (bytes_read < count)
1103 DEBUG("Read timed out");
1105 RETURN_INT(bytes_read);
1109 SP_API enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf,
1110 size_t count, unsigned int timeout_ms)
1112 TRACE("%p, %p, %d, %d", port, buf, count, timeout_ms);
1117 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1120 RETURN_ERROR(SP_ERR_ARG, "Zero count");
1123 DEBUG_FMT("Reading next max %d bytes from port %s, timeout %d ms",
1124 count, port->name, timeout_ms);
1126 DEBUG_FMT("Reading next max %d bytes from port %s, no timeout",
1130 DWORD bytes_read = 0;
1132 /* If timeout_ms == 0, set maximum timeout. */
1133 DWORD timeout_val = (timeout_ms == 0 ? MAXDWORD - 1 : timeout_ms);
1136 if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1137 port->timeouts.ReadTotalTimeoutMultiplier != MAXDWORD ||
1138 port->timeouts.ReadTotalTimeoutConstant != timeout_val) {
1139 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1140 port->timeouts.ReadTotalTimeoutMultiplier = MAXDWORD;
1141 port->timeouts.ReadTotalTimeoutConstant = timeout_val;
1142 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1143 RETURN_FAIL("SetCommTimeouts() failed");
1146 /* Loop until we have at least one byte, or timeout is reached. */
1147 while (bytes_read == 0) {
1149 if (ReadFile(port->hdl, buf, count, &bytes_read, &port->read_ovl)) {
1150 DEBUG("Read completed immediately");
1151 } else if (GetLastError() == ERROR_IO_PENDING) {
1152 DEBUG("Waiting for read to complete");
1153 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, TRUE) == 0)
1154 RETURN_FAIL("GetOverlappedResult() failed");
1155 if (bytes_read > 0) {
1156 DEBUG("Read completed");
1157 } else if (timeout_ms > 0) {
1158 DEBUG("Read timed out");
1161 DEBUG("Restarting read");
1164 RETURN_FAIL("ReadFile() failed");
1168 TRY(restart_wait_if_needed(port, bytes_read));
1170 RETURN_INT(bytes_read);
1173 size_t bytes_read = 0;
1174 struct timeout timeout;
1178 timeout_start(&timeout, timeout_ms);
1181 FD_SET(port->fd, &fds);
1183 /* Loop until we have at least one byte, or timeout is reached. */
1184 while (bytes_read == 0) {
1186 if (timeout_check(&timeout))
1187 /* Timeout has expired. */
1190 result = select(port->fd + 1, &fds, NULL, NULL, timeout_timeval(&timeout));
1192 timeout_update(&timeout);
1195 if (errno == EINTR) {
1196 DEBUG("select() call was interrupted, repeating");
1199 RETURN_FAIL("select() failed");
1201 } else if (result == 0) {
1202 /* Timeout has expired. */
1207 result = read(port->fd, buf, count);
1210 if (errno == EAGAIN)
1211 /* This shouldn't happen because we did a select() first, but handle anyway. */
1214 /* This is an actual failure. */
1215 RETURN_FAIL("read() failed");
1218 bytes_read = result;
1221 if (bytes_read == 0)
1222 DEBUG("Read timed out");
1224 RETURN_INT(bytes_read);
1228 SP_API enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf,
1231 TRACE("%p, %p, %d", port, buf, count);
1236 RETURN_ERROR(SP_ERR_ARG, "Null buffer");
1238 DEBUG_FMT("Reading up to %d bytes from port %s", count, port->name);
1244 if (port->timeouts.ReadIntervalTimeout != MAXDWORD ||
1245 port->timeouts.ReadTotalTimeoutMultiplier != 0 ||
1246 port->timeouts.ReadTotalTimeoutConstant != 0) {
1247 port->timeouts.ReadIntervalTimeout = MAXDWORD;
1248 port->timeouts.ReadTotalTimeoutMultiplier = 0;
1249 port->timeouts.ReadTotalTimeoutConstant = 0;
1250 if (SetCommTimeouts(port->hdl, &port->timeouts) == 0)
1251 RETURN_FAIL("SetCommTimeouts() failed");
1255 if (ReadFile(port->hdl, buf, count, NULL, &port->read_ovl) == 0)
1256 if (GetLastError() != ERROR_IO_PENDING)
1257 RETURN_FAIL("ReadFile() failed");
1259 /* Get number of bytes read. */
1260 if (GetOverlappedResult(port->hdl, &port->read_ovl, &bytes_read, FALSE) == 0)
1261 RETURN_FAIL("GetOverlappedResult() failed");
1263 TRY(restart_wait_if_needed(port, bytes_read));
1265 RETURN_INT(bytes_read);
1269 /* Returns the number of bytes read, or -1 upon failure. */
1270 if ((bytes_read = read(port->fd, buf, count)) < 0) {
1271 if (errno == EAGAIN)
1272 /* No bytes available. */
1275 /* This is an actual failure. */
1276 RETURN_FAIL("read() failed");
1278 RETURN_INT(bytes_read);
1282 SP_API enum sp_return sp_input_waiting(struct sp_port *port)
1288 DEBUG_FMT("Checking input bytes waiting on port %s", port->name);
1294 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1295 RETURN_FAIL("ClearCommError() failed");
1296 RETURN_INT(comstat.cbInQue);
1299 if (ioctl(port->fd, TIOCINQ, &bytes_waiting) < 0)
1300 RETURN_FAIL("TIOCINQ ioctl failed");
1301 RETURN_INT(bytes_waiting);
1305 SP_API enum sp_return sp_output_waiting(struct sp_port *port)
1311 DEBUG_FMT("Checking output bytes waiting on port %s", port->name);
1317 if (ClearCommError(port->hdl, &errors, &comstat) == 0)
1318 RETURN_FAIL("ClearCommError() failed");
1319 RETURN_INT(comstat.cbOutQue);
1322 if (ioctl(port->fd, TIOCOUTQ, &bytes_waiting) < 0)
1323 RETURN_FAIL("TIOCOUTQ ioctl failed");
1324 RETURN_INT(bytes_waiting);
1328 SP_API enum sp_return sp_new_event_set(struct sp_event_set **result_ptr)
1330 struct sp_event_set *result;
1332 TRACE("%p", result_ptr);
1335 RETURN_ERROR(SP_ERR_ARG, "Null result");
1339 if (!(result = malloc(sizeof(struct sp_event_set))))
1340 RETURN_ERROR(SP_ERR_MEM, "sp_event_set malloc() failed");
1342 memset(result, 0, sizeof(struct sp_event_set));
1344 *result_ptr = result;
1349 static enum sp_return add_handle(struct sp_event_set *event_set,
1350 event_handle handle, enum sp_event mask)
1353 enum sp_event *new_masks;
1355 TRACE("%p, %d, %d", event_set, handle, mask);
1357 if (!(new_handles = realloc(event_set->handles,
1358 sizeof(event_handle) * (event_set->count + 1))))
1359 RETURN_ERROR(SP_ERR_MEM, "Handle array realloc() failed");
1361 event_set->handles = new_handles;
1363 if (!(new_masks = realloc(event_set->masks,
1364 sizeof(enum sp_event) * (event_set->count + 1))))
1365 RETURN_ERROR(SP_ERR_MEM, "Mask array realloc() failed");
1367 event_set->masks = new_masks;
1369 ((event_handle *) event_set->handles)[event_set->count] = handle;
1370 event_set->masks[event_set->count] = mask;
1377 SP_API enum sp_return sp_add_port_events(struct sp_event_set *event_set,
1378 const struct sp_port *port, enum sp_event mask)
1380 TRACE("%p, %p, %d", event_set, port, mask);
1383 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1386 RETURN_ERROR(SP_ERR_ARG, "Null port");
1388 if (mask > (SP_EVENT_RX_READY | SP_EVENT_TX_READY | SP_EVENT_ERROR))
1389 RETURN_ERROR(SP_ERR_ARG, "Invalid event mask");
1395 enum sp_event handle_mask;
1396 if ((handle_mask = mask & SP_EVENT_TX_READY))
1397 TRY(add_handle(event_set, port->write_ovl.hEvent, handle_mask));
1398 if ((handle_mask = mask & (SP_EVENT_RX_READY | SP_EVENT_ERROR)))
1399 TRY(add_handle(event_set, port->wait_ovl.hEvent, handle_mask));
1401 TRY(add_handle(event_set, port->fd, mask));
1407 SP_API void sp_free_event_set(struct sp_event_set *event_set)
1409 TRACE("%p", event_set);
1412 DEBUG("Null event set");
1416 DEBUG("Freeing event set");
1418 if (event_set->handles)
1419 free(event_set->handles);
1420 if (event_set->masks)
1421 free(event_set->masks);
1428 SP_API enum sp_return sp_wait(struct sp_event_set *event_set,
1429 unsigned int timeout_ms)
1431 TRACE("%p, %d", event_set, timeout_ms);
1434 RETURN_ERROR(SP_ERR_ARG, "Null event set");
1437 if (WaitForMultipleObjects(event_set->count, event_set->handles, FALSE,
1438 timeout_ms ? timeout_ms : INFINITE) == WAIT_FAILED)
1439 RETURN_FAIL("WaitForMultipleObjects() failed");
1443 struct timeout timeout;
1445 struct pollfd *pollfds;
1448 if (!(pollfds = malloc(sizeof(struct pollfd) * event_set->count)))
1449 RETURN_ERROR(SP_ERR_MEM, "pollfds malloc() failed");
1451 for (i = 0; i < event_set->count; i++) {
1452 pollfds[i].fd = ((int *)event_set->handles)[i];
1453 pollfds[i].events = 0;
1454 pollfds[i].revents = 0;
1455 if (event_set->masks[i] & SP_EVENT_RX_READY)
1456 pollfds[i].events |= POLLIN;
1457 if (event_set->masks[i] & SP_EVENT_TX_READY)
1458 pollfds[i].events |= POLLOUT;
1459 if (event_set->masks[i] & SP_EVENT_ERROR)
1460 pollfds[i].events |= POLLERR;
1463 timeout_start(&timeout, timeout_ms);
1464 timeout_limit(&timeout, INT_MAX);
1466 /* Loop until an event occurs. */
1469 if (timeout_check(&timeout)) {
1470 DEBUG("Wait timed out");
1474 result = poll(pollfds, event_set->count, timeout_remaining_ms(&timeout) || -1);
1476 timeout_update(&timeout);
1479 if (errno == EINTR) {
1480 DEBUG("poll() call was interrupted, repeating");
1484 RETURN_FAIL("poll() failed");
1486 } else if (result == 0) {
1487 DEBUG("poll() timed out");
1488 if (!timeout.overflow)
1491 DEBUG("poll() completed");
1501 #ifdef USE_TERMIOS_SPEED
1502 static enum sp_return get_baudrate(int fd, int *baudrate)
1506 TRACE("%d, %p", fd, baudrate);
1508 DEBUG("Getting baud rate");
1510 if (!(data = malloc(get_termios_size())))
1511 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1513 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1515 RETURN_FAIL("Getting termios failed");
1518 *baudrate = get_termios_speed(data);
1525 static enum sp_return set_baudrate(int fd, int baudrate)
1529 TRACE("%d, %d", fd, baudrate);
1531 DEBUG("Getting baud rate");
1533 if (!(data = malloc(get_termios_size())))
1534 RETURN_ERROR(SP_ERR_MEM, "termios malloc failed");
1536 if (ioctl(fd, get_termios_get_ioctl(), data) < 0) {
1538 RETURN_FAIL("Getting termios failed");
1541 DEBUG("Setting baud rate");
1543 set_termios_speed(data, baudrate);
1545 if (ioctl(fd, get_termios_set_ioctl(), data) < 0) {
1547 RETURN_FAIL("Setting termios failed");
1554 #endif /* USE_TERMIOS_SPEED */
1557 static enum sp_return get_flow(int fd, struct port_data *data)
1561 TRACE("%d, %p", fd, data);
1563 DEBUG("Getting advanced flow control");
1565 if (!(termx = malloc(get_termiox_size())))
1566 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1568 if (ioctl(fd, TCGETX, termx) < 0) {
1570 RETURN_FAIL("Getting termiox failed");
1573 get_termiox_flow(termx, &data->rts_flow, &data->cts_flow,
1574 &data->dtr_flow, &data->dsr_flow);
1581 static enum sp_return set_flow(int fd, struct port_data *data)
1585 TRACE("%d, %p", fd, data);
1587 DEBUG("Getting advanced flow control");
1589 if (!(termx = malloc(get_termiox_size())))
1590 RETURN_ERROR(SP_ERR_MEM, "termiox malloc failed");
1592 if (ioctl(fd, TCGETX, termx) < 0) {
1594 RETURN_FAIL("Getting termiox failed");
1597 DEBUG("Setting advanced flow control");
1599 set_termiox_flow(termx, data->rts_flow, data->cts_flow,
1600 data->dtr_flow, data->dsr_flow);
1602 if (ioctl(fd, TCSETX, termx) < 0) {
1604 RETURN_FAIL("Setting termiox failed");
1611 #endif /* USE_TERMIOX */
1613 static enum sp_return get_config(struct sp_port *port, struct port_data *data,
1614 struct sp_port_config *config)
1618 TRACE("%p, %p, %p", port, data, config);
1620 DEBUG_FMT("Getting configuration for port %s", port->name);
1623 if (!GetCommState(port->hdl, &data->dcb))
1624 RETURN_FAIL("GetCommState() failed");
1626 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1627 if (data->dcb.BaudRate == std_baudrates[i].index) {
1628 config->baudrate = std_baudrates[i].value;
1633 if (i == NUM_STD_BAUDRATES)
1634 /* BaudRate field can be either an index or a custom baud rate. */
1635 config->baudrate = data->dcb.BaudRate;
1637 config->bits = data->dcb.ByteSize;
1639 if (data->dcb.fParity)
1640 switch (data->dcb.Parity) {
1642 config->parity = SP_PARITY_NONE;
1645 config->parity = SP_PARITY_ODD;
1648 config->parity = SP_PARITY_EVEN;
1651 config->parity = SP_PARITY_MARK;
1654 config->parity = SP_PARITY_SPACE;
1657 config->parity = -1;
1660 config->parity = SP_PARITY_NONE;
1662 switch (data->dcb.StopBits) {
1664 config->stopbits = 1;
1667 config->stopbits = 2;
1670 config->stopbits = -1;
1673 switch (data->dcb.fRtsControl) {
1674 case RTS_CONTROL_DISABLE:
1675 config->rts = SP_RTS_OFF;
1677 case RTS_CONTROL_ENABLE:
1678 config->rts = SP_RTS_ON;
1680 case RTS_CONTROL_HANDSHAKE:
1681 config->rts = SP_RTS_FLOW_CONTROL;
1687 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1689 switch (data->dcb.fDtrControl) {
1690 case DTR_CONTROL_DISABLE:
1691 config->dtr = SP_DTR_OFF;
1693 case DTR_CONTROL_ENABLE:
1694 config->dtr = SP_DTR_ON;
1696 case DTR_CONTROL_HANDSHAKE:
1697 config->dtr = SP_DTR_FLOW_CONTROL;
1703 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1705 if (data->dcb.fInX) {
1706 if (data->dcb.fOutX)
1707 config->xon_xoff = SP_XONXOFF_INOUT;
1709 config->xon_xoff = SP_XONXOFF_IN;
1711 if (data->dcb.fOutX)
1712 config->xon_xoff = SP_XONXOFF_OUT;
1714 config->xon_xoff = SP_XONXOFF_DISABLED;
1719 if (tcgetattr(port->fd, &data->term) < 0)
1720 RETURN_FAIL("tcgetattr() failed");
1722 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
1723 RETURN_FAIL("TIOCMGET ioctl failed");
1726 int ret = get_flow(port->fd, data);
1728 if (ret == SP_ERR_FAIL && errno == EINVAL)
1729 data->termiox_supported = 0;
1731 RETURN_CODEVAL(ret);
1733 data->termiox_supported = 1;
1735 data->termiox_supported = 0;
1738 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1739 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
1740 config->baudrate = std_baudrates[i].value;
1745 if (i == NUM_STD_BAUDRATES) {
1747 config->baudrate = (int)data->term.c_ispeed;
1748 #elif defined(USE_TERMIOS_SPEED)
1749 TRY(get_baudrate(port->fd, &config->baudrate));
1751 config->baudrate = -1;
1755 switch (data->term.c_cflag & CSIZE) {
1772 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
1773 config->parity = SP_PARITY_NONE;
1774 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
1775 config->parity = -1;
1777 else if (data->term.c_cflag & CMSPAR)
1778 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_MARK : SP_PARITY_SPACE;
1781 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
1783 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
1785 if (data->term.c_cflag & CRTSCTS) {
1786 config->rts = SP_RTS_FLOW_CONTROL;
1787 config->cts = SP_CTS_FLOW_CONTROL;
1789 if (data->termiox_supported && data->rts_flow)
1790 config->rts = SP_RTS_FLOW_CONTROL;
1792 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
1794 config->cts = (data->termiox_supported && data->cts_flow) ?
1795 SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
1798 if (data->termiox_supported && data->dtr_flow)
1799 config->dtr = SP_DTR_FLOW_CONTROL;
1801 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
1803 config->dsr = (data->termiox_supported && data->dsr_flow) ?
1804 SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
1806 if (data->term.c_iflag & IXOFF) {
1807 if (data->term.c_iflag & IXON)
1808 config->xon_xoff = SP_XONXOFF_INOUT;
1810 config->xon_xoff = SP_XONXOFF_IN;
1812 if (data->term.c_iflag & IXON)
1813 config->xon_xoff = SP_XONXOFF_OUT;
1815 config->xon_xoff = SP_XONXOFF_DISABLED;
1822 static enum sp_return set_config(struct sp_port *port, struct port_data *data,
1823 const struct sp_port_config *config)
1827 BAUD_TYPE baud_nonstd;
1831 #ifdef USE_TERMIOS_SPEED
1832 int baud_nonstd = 0;
1835 TRACE("%p, %p, %p", port, data, config);
1837 DEBUG_FMT("Setting configuration for port %s", port->name);
1841 TRY(await_write_completion(port));
1843 if (config->baudrate >= 0) {
1844 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1845 if (config->baudrate == std_baudrates[i].value) {
1846 data->dcb.BaudRate = std_baudrates[i].index;
1851 if (i == NUM_STD_BAUDRATES)
1852 data->dcb.BaudRate = config->baudrate;
1854 /* Allocate write buffer for 50ms of data at baud rate. */
1855 port->write_buf_size = max(config->baudrate / (8 * 20), 1);
1856 port->write_buf = realloc(port->write_buf,
1857 port->write_buf_size);
1859 if (!port->write_buf)
1860 RETURN_ERROR(SP_ERR_MEM, "Allocating write buffer failed");
1863 if (config->bits >= 0)
1864 data->dcb.ByteSize = config->bits;
1866 if (config->parity >= 0) {
1867 switch (config->parity) {
1868 case SP_PARITY_NONE:
1869 data->dcb.Parity = NOPARITY;
1872 data->dcb.Parity = ODDPARITY;
1874 case SP_PARITY_EVEN:
1875 data->dcb.Parity = EVENPARITY;
1877 case SP_PARITY_MARK:
1878 data->dcb.Parity = MARKPARITY;
1880 case SP_PARITY_SPACE:
1881 data->dcb.Parity = SPACEPARITY;
1884 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
1888 if (config->stopbits >= 0) {
1889 switch (config->stopbits) {
1890 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
1892 data->dcb.StopBits = ONESTOPBIT;
1895 data->dcb.StopBits = TWOSTOPBITS;
1898 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bit setting");
1902 if (config->rts >= 0) {
1903 switch (config->rts) {
1905 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
1908 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
1910 case SP_RTS_FLOW_CONTROL:
1911 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
1914 RETURN_ERROR(SP_ERR_ARG, "Invalid RTS setting");
1918 if (config->cts >= 0) {
1919 switch (config->cts) {
1921 data->dcb.fOutxCtsFlow = FALSE;
1923 case SP_CTS_FLOW_CONTROL:
1924 data->dcb.fOutxCtsFlow = TRUE;
1927 RETURN_ERROR(SP_ERR_ARG, "Invalid CTS setting");
1931 if (config->dtr >= 0) {
1932 switch (config->dtr) {
1934 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
1937 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
1939 case SP_DTR_FLOW_CONTROL:
1940 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
1943 RETURN_ERROR(SP_ERR_ARG, "Invalid DTR setting");
1947 if (config->dsr >= 0) {
1948 switch (config->dsr) {
1950 data->dcb.fOutxDsrFlow = FALSE;
1952 case SP_DSR_FLOW_CONTROL:
1953 data->dcb.fOutxDsrFlow = TRUE;
1956 RETURN_ERROR(SP_ERR_ARG, "Invalid DSR setting");
1960 if (config->xon_xoff >= 0) {
1961 switch (config->xon_xoff) {
1962 case SP_XONXOFF_DISABLED:
1963 data->dcb.fInX = FALSE;
1964 data->dcb.fOutX = FALSE;
1967 data->dcb.fInX = TRUE;
1968 data->dcb.fOutX = FALSE;
1970 case SP_XONXOFF_OUT:
1971 data->dcb.fInX = FALSE;
1972 data->dcb.fOutX = TRUE;
1974 case SP_XONXOFF_INOUT:
1975 data->dcb.fInX = TRUE;
1976 data->dcb.fOutX = TRUE;
1979 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
1983 if (!SetCommState(port->hdl, &data->dcb))
1984 RETURN_FAIL("SetCommState() failed");
1990 if (config->baudrate >= 0) {
1991 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
1992 if (config->baudrate == std_baudrates[i].value) {
1993 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
1994 RETURN_FAIL("cfsetospeed() failed");
1996 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
1997 RETURN_FAIL("cfsetispeed() failed");
2002 /* Non-standard baud rate */
2003 if (i == NUM_STD_BAUDRATES) {
2005 /* Set "dummy" baud rate. */
2006 if (cfsetspeed(&data->term, B9600) < 0)
2007 RETURN_FAIL("cfsetspeed() failed");
2008 baud_nonstd = config->baudrate;
2009 #elif defined(USE_TERMIOS_SPEED)
2012 RETURN_ERROR(SP_ERR_SUPP, "Non-standard baudrate not supported");
2017 if (config->bits >= 0) {
2018 data->term.c_cflag &= ~CSIZE;
2019 switch (config->bits) {
2021 data->term.c_cflag |= CS8;
2024 data->term.c_cflag |= CS7;
2027 data->term.c_cflag |= CS6;
2030 data->term.c_cflag |= CS5;
2033 RETURN_ERROR(SP_ERR_ARG, "Invalid data bits setting");
2037 if (config->parity >= 0) {
2038 data->term.c_iflag &= ~IGNPAR;
2039 data->term.c_cflag &= ~(PARENB | PARODD);
2041 data->term.c_cflag &= ~CMSPAR;
2043 switch (config->parity) {
2044 case SP_PARITY_NONE:
2045 data->term.c_iflag |= IGNPAR;
2047 case SP_PARITY_EVEN:
2048 data->term.c_cflag |= PARENB;
2051 data->term.c_cflag |= PARENB | PARODD;
2054 case SP_PARITY_MARK:
2055 data->term.c_cflag |= PARENB | PARODD;
2056 data->term.c_cflag |= CMSPAR;
2058 case SP_PARITY_SPACE:
2059 data->term.c_cflag |= PARENB;
2060 data->term.c_cflag |= CMSPAR;
2063 case SP_PARITY_MARK:
2064 case SP_PARITY_SPACE:
2065 RETURN_ERROR(SP_ERR_SUPP, "Mark/space parity not supported");
2068 RETURN_ERROR(SP_ERR_ARG, "Invalid parity setting");
2072 if (config->stopbits >= 0) {
2073 data->term.c_cflag &= ~CSTOPB;
2074 switch (config->stopbits) {
2076 data->term.c_cflag &= ~CSTOPB;
2079 data->term.c_cflag |= CSTOPB;
2082 RETURN_ERROR(SP_ERR_ARG, "Invalid stop bits setting");
2086 if (config->rts >= 0 || config->cts >= 0) {
2087 if (data->termiox_supported) {
2088 data->rts_flow = data->cts_flow = 0;
2089 switch (config->rts) {
2092 controlbits = TIOCM_RTS;
2093 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
2094 RETURN_FAIL("Setting RTS signal level failed");
2096 case SP_RTS_FLOW_CONTROL:
2102 if (config->cts == SP_CTS_FLOW_CONTROL)
2105 if (data->rts_flow && data->cts_flow)
2106 data->term.c_iflag |= CRTSCTS;
2108 data->term.c_iflag &= ~CRTSCTS;
2110 /* Asymmetric use of RTS/CTS not supported. */
2111 if (data->term.c_iflag & CRTSCTS) {
2112 /* Flow control can only be disabled for both RTS & CTS together. */
2113 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
2114 if (config->cts != SP_CTS_IGNORE)
2115 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
2117 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
2118 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
2119 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be disabled together");
2122 /* Flow control can only be enabled for both RTS & CTS together. */
2123 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
2124 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
2125 RETURN_ERROR(SP_ERR_SUPP, "RTS & CTS flow control must be enabled together");
2128 if (config->rts >= 0) {
2129 if (config->rts == SP_RTS_FLOW_CONTROL) {
2130 data->term.c_iflag |= CRTSCTS;
2132 controlbits = TIOCM_RTS;
2133 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
2135 RETURN_FAIL("Setting RTS signal level failed");
2141 if (config->dtr >= 0 || config->dsr >= 0) {
2142 if (data->termiox_supported) {
2143 data->dtr_flow = data->dsr_flow = 0;
2144 switch (config->dtr) {
2147 controlbits = TIOCM_DTR;
2148 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC, &controlbits) < 0)
2149 RETURN_FAIL("Setting DTR signal level failed");
2151 case SP_DTR_FLOW_CONTROL:
2157 if (config->dsr == SP_DSR_FLOW_CONTROL)
2160 /* DTR/DSR flow control not supported. */
2161 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
2162 RETURN_ERROR(SP_ERR_SUPP, "DTR/DSR flow control not supported");
2164 if (config->dtr >= 0) {
2165 controlbits = TIOCM_DTR;
2166 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
2168 RETURN_FAIL("Setting DTR signal level failed");
2173 if (config->xon_xoff >= 0) {
2174 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
2175 switch (config->xon_xoff) {
2176 case SP_XONXOFF_DISABLED:
2179 data->term.c_iflag |= IXOFF;
2181 case SP_XONXOFF_OUT:
2182 data->term.c_iflag |= IXON | IXANY;
2184 case SP_XONXOFF_INOUT:
2185 data->term.c_iflag |= IXON | IXOFF | IXANY;
2188 RETURN_ERROR(SP_ERR_ARG, "Invalid XON/XOFF setting");
2192 if (tcsetattr(port->fd, TCSANOW, &data->term) < 0)
2193 RETURN_FAIL("tcsetattr() failed");
2196 if (baud_nonstd != B0) {
2197 if (ioctl(port->fd, IOSSIOSPEED, &baud_nonstd) == -1)
2198 RETURN_FAIL("IOSSIOSPEED ioctl failed");
2200 * Set baud rates in data->term to correct, but incompatible
2201 * with tcsetattr() value, same as delivered by tcgetattr().
2203 if (cfsetspeed(&data->term, baud_nonstd) < 0)
2204 RETURN_FAIL("cfsetspeed() failed");
2206 #elif defined(__linux__)
2207 #ifdef USE_TERMIOS_SPEED
2209 TRY(set_baudrate(port->fd, config->baudrate));
2212 if (data->termiox_supported)
2213 TRY(set_flow(port->fd, data));
2217 #endif /* !_WIN32 */
2222 SP_API enum sp_return sp_new_config(struct sp_port_config **config_ptr)
2224 struct sp_port_config *config;
2226 TRACE("%p", config_ptr);
2229 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2233 if (!(config = malloc(sizeof(struct sp_port_config))))
2234 RETURN_ERROR(SP_ERR_MEM, "Config malloc failed");
2236 config->baudrate = -1;
2238 config->parity = -1;
2239 config->stopbits = -1;
2245 *config_ptr = config;
2250 SP_API void sp_free_config(struct sp_port_config *config)
2252 TRACE("%p", config);
2255 DEBUG("Null config");
2262 SP_API enum sp_return sp_get_config(struct sp_port *port,
2263 struct sp_port_config *config)
2265 struct port_data data;
2267 TRACE("%p, %p", port, config);
2272 RETURN_ERROR(SP_ERR_ARG, "Null config");
2274 TRY(get_config(port, &data, config));
2279 SP_API enum sp_return sp_set_config(struct sp_port *port,
2280 const struct sp_port_config *config)
2282 struct port_data data;
2283 struct sp_port_config prev_config;
2285 TRACE("%p, %p", port, config);
2290 RETURN_ERROR(SP_ERR_ARG, "Null config");
2292 TRY(get_config(port, &data, &prev_config));
2293 TRY(set_config(port, &data, config));
2298 #define CREATE_ACCESSORS(x, type) \
2299 SP_API enum sp_return sp_set_##x(struct sp_port *port, type x) { \
2300 struct port_data data; \
2301 struct sp_port_config config; \
2302 TRACE("%p, %d", port, x); \
2303 CHECK_OPEN_PORT(); \
2304 TRY(get_config(port, &data, &config)); \
2306 TRY(set_config(port, &data, &config)); \
2309 SP_API enum sp_return sp_get_config_##x(const struct sp_port_config *config, \
2311 TRACE("%p, %p", config, x); \
2313 RETURN_ERROR(SP_ERR_ARG, "Null result pointer"); \
2315 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2319 SP_API enum sp_return sp_set_config_##x(struct sp_port_config *config, \
2321 TRACE("%p, %d", config, x); \
2323 RETURN_ERROR(SP_ERR_ARG, "Null config"); \
2328 CREATE_ACCESSORS(baudrate, int)
2329 CREATE_ACCESSORS(bits, int)
2330 CREATE_ACCESSORS(parity, enum sp_parity)
2331 CREATE_ACCESSORS(stopbits, int)
2332 CREATE_ACCESSORS(rts, enum sp_rts)
2333 CREATE_ACCESSORS(cts, enum sp_cts)
2334 CREATE_ACCESSORS(dtr, enum sp_dtr)
2335 CREATE_ACCESSORS(dsr, enum sp_dsr)
2336 CREATE_ACCESSORS(xon_xoff, enum sp_xonxoff)
2338 SP_API enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config,
2339 enum sp_flowcontrol flowcontrol)
2342 RETURN_ERROR(SP_ERR_ARG, "Null configuration");
2344 if (flowcontrol > SP_FLOWCONTROL_DTRDSR)
2345 RETURN_ERROR(SP_ERR_ARG, "Invalid flow control setting");
2347 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
2348 config->xon_xoff = SP_XONXOFF_INOUT;
2350 config->xon_xoff = SP_XONXOFF_DISABLED;
2352 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
2353 config->rts = SP_RTS_FLOW_CONTROL;
2354 config->cts = SP_CTS_FLOW_CONTROL;
2356 if (config->rts == SP_RTS_FLOW_CONTROL)
2357 config->rts = SP_RTS_ON;
2358 config->cts = SP_CTS_IGNORE;
2361 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
2362 config->dtr = SP_DTR_FLOW_CONTROL;
2363 config->dsr = SP_DSR_FLOW_CONTROL;
2365 if (config->dtr == SP_DTR_FLOW_CONTROL)
2366 config->dtr = SP_DTR_ON;
2367 config->dsr = SP_DSR_IGNORE;
2373 SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port,
2374 enum sp_flowcontrol flowcontrol)
2376 struct port_data data;
2377 struct sp_port_config config;
2379 TRACE("%p, %d", port, flowcontrol);
2383 TRY(get_config(port, &data, &config));
2385 TRY(sp_set_config_flowcontrol(&config, flowcontrol));
2387 TRY(set_config(port, &data, &config));
2392 SP_API enum sp_return sp_get_signals(struct sp_port *port,
2393 enum sp_signal *signals)
2395 TRACE("%p, %p", port, signals);
2400 RETURN_ERROR(SP_ERR_ARG, "Null result pointer");
2402 DEBUG_FMT("Getting control signals for port %s", port->name);
2407 if (GetCommModemStatus(port->hdl, &bits) == 0)
2408 RETURN_FAIL("GetCommModemStatus() failed");
2409 if (bits & MS_CTS_ON)
2410 *signals |= SP_SIG_CTS;
2411 if (bits & MS_DSR_ON)
2412 *signals |= SP_SIG_DSR;
2413 if (bits & MS_RLSD_ON)
2414 *signals |= SP_SIG_DCD;
2415 if (bits & MS_RING_ON)
2416 *signals |= SP_SIG_RI;
2419 if (ioctl(port->fd, TIOCMGET, &bits) < 0)
2420 RETURN_FAIL("TIOCMGET ioctl failed");
2421 if (bits & TIOCM_CTS)
2422 *signals |= SP_SIG_CTS;
2423 if (bits & TIOCM_DSR)
2424 *signals |= SP_SIG_DSR;
2425 if (bits & TIOCM_CAR)
2426 *signals |= SP_SIG_DCD;
2427 if (bits & TIOCM_RNG)
2428 *signals |= SP_SIG_RI;
2433 SP_API enum sp_return sp_start_break(struct sp_port *port)
2439 if (SetCommBreak(port->hdl) == 0)
2440 RETURN_FAIL("SetCommBreak() failed");
2442 if (ioctl(port->fd, TIOCSBRK, 1) < 0)
2443 RETURN_FAIL("TIOCSBRK ioctl failed");
2449 SP_API enum sp_return sp_end_break(struct sp_port *port)
2455 if (ClearCommBreak(port->hdl) == 0)
2456 RETURN_FAIL("ClearCommBreak() failed");
2458 if (ioctl(port->fd, TIOCCBRK, 1) < 0)
2459 RETURN_FAIL("TIOCCBRK ioctl failed");
2465 SP_API int sp_last_error_code(void)
2469 RETURN_INT(GetLastError());
2475 SP_API char *sp_last_error_message(void)
2481 DWORD error = GetLastError();
2483 DWORD length = FormatMessage(
2484 FORMAT_MESSAGE_ALLOCATE_BUFFER |
2485 FORMAT_MESSAGE_FROM_SYSTEM |
2486 FORMAT_MESSAGE_IGNORE_INSERTS,
2489 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
2493 if (length >= 2 && message[length - 2] == '\r')
2494 message[length - 2] = '\0';
2496 RETURN_STRING(message);
2498 RETURN_STRING(strerror(errno));
2502 SP_API void sp_free_error_message(char *message)
2504 TRACE("%s", message);
2515 SP_API void sp_set_debug_handler(void (*handler)(const char *format, ...))
2517 TRACE("%p", handler);
2519 sp_debug_handler = handler;
2524 SP_API void sp_default_debug_handler(const char *format, ...)
2527 va_start(args, format);
2528 if (getenv("LIBSERIALPORT_DEBUG")) {
2529 fputs("sp: ", stderr);
2530 vfprintf(stderr, format, args);
2535 SP_API int sp_get_major_package_version(void)
2537 return SP_PACKAGE_VERSION_MAJOR;
2540 SP_API int sp_get_minor_package_version(void)
2542 return SP_PACKAGE_VERSION_MINOR;
2545 SP_API int sp_get_micro_package_version(void)
2547 return SP_PACKAGE_VERSION_MICRO;
2550 SP_API const char *sp_get_package_version_string(void)
2552 return SP_PACKAGE_VERSION_STRING;
2555 SP_API int sp_get_current_lib_version(void)
2557 return SP_LIB_VERSION_CURRENT;
2560 SP_API int sp_get_revision_lib_version(void)
2562 return SP_LIB_VERSION_REVISION;
2565 SP_API int sp_get_age_lib_version(void)
2567 return SP_LIB_VERSION_AGE;
2570 SP_API const char *sp_get_lib_version_string(void)
2572 return SP_LIB_VERSION_STRING;