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>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as
10 * published by the Free Software Foundation, either version 3 of the
11 * License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <sys/types.h>
35 #include <sys/ioctl.h>
38 #include <IOKit/IOKitLib.h>
39 #include <IOKit/serial/IOSerialKeys.h>
40 #include <sys/syslimits.h>
44 #include "linux/serial.h"
47 #include "libserialport.h"
58 /* Standard baud rates. */
60 #define BAUD_TYPE DWORD
61 #define BAUD(n) {CBR_##n, n}
63 #define BAUD_TYPE speed_t
64 #define BAUD(n) {B##n, n}
72 const struct std_baudrate std_baudrates[] = {
75 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
76 * have documented CBR_* macros.
78 BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
79 BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
80 BAUD(115200), BAUD(128000), BAUD(256000)
82 BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200), BAUD(300),
83 BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800), BAUD(9600),
84 BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200), BAUD(230400),
85 #if !defined(__APPLE__) && !defined(__OpenBSD__)
91 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
92 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
94 /* Helper functions for configuring ports. */
95 static int get_config(struct sp_port *port, struct sp_port_data *data, struct sp_port_config *config);
96 static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp_port_config *config);
98 int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
100 struct sp_port *port;
111 if (!(port = malloc(sizeof(struct sp_port))))
114 len = strlen(portname) + 1;
116 if (!(port->name = malloc(len)))
122 memcpy(port->name, portname, len);
125 port->hdl = INVALID_HANDLE_VALUE;
135 int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
142 if (!port || !port->name)
145 return sp_get_port_by_name(port->name, copy_ptr);
148 void sp_free_port(struct sp_port *port)
159 static struct sp_port **sp_list_append(struct sp_port **list, const char *portname)
164 for (count = 0; list[count]; count++);
165 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
168 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
170 list[count + 1] = NULL;
174 sp_free_port_list(list);
178 int sp_list_ports(struct sp_port ***list_ptr)
180 struct sp_port **list;
183 if (!(list = malloc(sizeof(struct sp_port **))))
191 DWORD max_value_len, max_data_size, max_data_len;
192 DWORD value_len, data_size, data_len;
193 DWORD type, index = 0;
197 if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
198 0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS)
203 if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
204 &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS)
209 max_data_len = max_data_size / sizeof(TCHAR);
210 if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR))))
215 if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR))))
221 value_len = max_value_len + 1,
222 data_size = max_data_size,
223 RegEnumValue(key, index, value, &value_len,
224 NULL, &type, (LPBYTE)data, &data_size) == ERROR_SUCCESS)
226 data_len = data_size / sizeof(TCHAR);
227 data[data_len] = '\0';
229 name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
231 name_len = data_len + 1;
233 if (!(name = malloc(name_len)))
239 WideCharToMultiByte(CP_ACP, 0, data, -1, name, name_len, NULL, NULL);
243 if (type == REG_SZ && !(list = sp_list_append(list, name)))
260 CFMutableDictionaryRef classes;
267 if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS)
273 if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue)))
279 CFDictionarySetValue(classes,
280 CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
282 if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS)
288 if (!(path = malloc(PATH_MAX)))
294 while ((port = IOIteratorNext(iter))) {
295 cf_path = IORegistryEntryCreateCFProperty(port,
296 CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
298 result = CFStringGetCString(cf_path,
299 path, PATH_MAX, kCFStringEncodingASCII);
301 if (result && !(list = sp_list_append(list, path)))
304 IOObjectRelease(port);
308 IOObjectRelease(port);
313 IOObjectRelease(iter);
318 struct udev_enumerate *ud_enumerate;
319 struct udev_list_entry *ud_list;
320 struct udev_list_entry *ud_entry;
322 struct udev_device *ud_dev, *ud_parent;
325 int fd, ioctl_result;
326 struct serial_struct serial_info;
329 ud_enumerate = udev_enumerate_new(ud);
330 udev_enumerate_add_match_subsystem(ud_enumerate, "tty");
331 udev_enumerate_scan_devices(ud_enumerate);
332 ud_list = udev_enumerate_get_list_entry(ud_enumerate);
333 udev_list_entry_foreach(ud_entry, ud_list)
335 path = udev_list_entry_get_name(ud_entry);
336 ud_dev = udev_device_new_from_syspath(ud, path);
337 /* If there is no parent device, this is a virtual tty. */
338 ud_parent = udev_device_get_parent(ud_dev);
339 if (ud_parent == NULL)
341 udev_device_unref(ud_dev);
344 name = udev_device_get_devnode(ud_dev);
345 /* The serial8250 driver has a hardcoded number of ports.
346 * The only way to tell which actually exist on a given system
347 * is to try to open them and make an ioctl call. */
348 driver = udev_device_get_driver(ud_parent);
349 if (driver && !strcmp(driver, "serial8250"))
351 if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0)
353 ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
355 if (ioctl_result != 0)
357 if (serial_info.type == PORT_UNKNOWN)
360 list = sp_list_append(list, name);
362 udev_device_unref(ud_dev);
370 udev_enumerate_unref(ud_enumerate);
381 sp_free_port_list(list);
389 void sp_free_port_list(struct sp_port **list)
393 for (i = 0; list[i]; i++)
394 sp_free_port(list[i]);
398 static int sp_validate_port(struct sp_port *port)
403 if (port->hdl == INVALID_HANDLE_VALUE)
412 #define CHECK_PORT() do { if (!sp_validate_port(port)) return SP_ERR_ARG; } while (0)
414 int sp_open(struct sp_port *port, int flags)
420 DWORD desired_access = 0, flags_and_attributes = 0;
421 char *escaped_port_name;
423 /* Prefix port name with '\\.\' to work with ports above COM9. */
424 if (!(escaped_port_name = malloc(strlen(port->name + 5))))
426 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
428 /* Map 'flags' to the OS-specific settings. */
429 desired_access |= GENERIC_READ;
430 flags_and_attributes = FILE_ATTRIBUTE_NORMAL;
431 if (flags & SP_MODE_RDWR)
432 desired_access |= GENERIC_WRITE;
433 if (flags & SP_MODE_NONBLOCK)
434 flags_and_attributes |= FILE_FLAG_OVERLAPPED;
436 port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
437 OPEN_EXISTING, flags_and_attributes, 0);
439 free(escaped_port_name);
441 if (port->hdl == INVALID_HANDLE_VALUE)
445 struct sp_port_data data;
446 struct sp_port_config config;
449 /* Map 'flags' to the OS-specific settings. */
450 if (flags & SP_MODE_RDWR)
451 flags_local |= O_RDWR;
452 if (flags & SP_MODE_RDONLY)
453 flags_local |= O_RDONLY;
454 if (flags & SP_MODE_NONBLOCK)
455 flags_local |= O_NONBLOCK;
457 if ((port->fd = open(port->name, flags_local)) < 0)
460 ret = get_config(port, &data, &config);
468 /* Turn off all serial port cooking. */
469 data.term.c_iflag &= ~(ISTRIP | INLCR | ICRNL);
470 data.term.c_oflag &= ~(ONLCR | OCRNL | ONOCR);
471 #if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
472 data.term.c_oflag &= ~OFILL;
474 /* Disable canonical mode, and don't echo input characters. */
475 data.term.c_lflag &= ~(ICANON | ECHO);
477 /* Ignore modem status lines; enable receiver */
478 data.term.c_cflag |= (CLOCAL | CREAD);
480 ret = set_config(port, &data, &config);
492 int sp_close(struct sp_port *port)
497 /* Returns non-zero upon success, 0 upon failure. */
498 if (CloseHandle(port->hdl) == 0)
500 port->hdl = INVALID_HANDLE_VALUE;
502 /* Returns 0 upon success, -1 upon failure. */
503 if (close(port->fd) == -1)
511 int sp_flush(struct sp_port *port)
516 /* Returns non-zero upon success, 0 upon failure. */
517 if (PurgeComm(port->hdl, PURGE_RXCLEAR | PURGE_TXCLEAR) == 0)
520 /* Returns 0 upon success, -1 upon failure. */
521 if (tcflush(port->fd, TCIOFLUSH) < 0)
527 int sp_write(struct sp_port *port, const void *buf, size_t count)
537 /* Returns non-zero upon success, 0 upon failure. */
538 if (WriteFile(port->hdl, buf, count, &written, NULL) == 0)
542 /* Returns the number of bytes written, or -1 upon failure. */
543 ssize_t written = write(port->fd, buf, count);
552 int sp_read(struct sp_port *port, void *buf, size_t count)
560 DWORD bytes_read = 0;
562 /* Returns non-zero upon success, 0 upon failure. */
563 if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0)
569 /* Returns the number of bytes read, or -1 upon failure. */
570 if ((bytes_read = read(port->fd, buf, count)) < 0)
576 static int get_config(struct sp_port *port, struct sp_port_data *data, struct sp_port_config *config)
581 if (!GetCommState(port->hdl, &data->dcb))
584 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
585 if (data->dcb.BaudRate == std_baudrates[i].index) {
586 config->baudrate = std_baudrates[i].value;
591 if (i == NUM_STD_BAUDRATES)
592 /* BaudRate field can be either an index or a custom baud rate. */
593 config->baudrate = data->dcb.BaudRate;
595 config->bits = data->dcb.ByteSize;
597 if (data->dcb.fParity)
598 switch (data->dcb.Parity) {
600 config->parity = SP_PARITY_NONE;
603 config->parity = SP_PARITY_EVEN;
606 config->parity = SP_PARITY_ODD;
612 config->parity = SP_PARITY_NONE;
614 switch (data->dcb.StopBits) {
616 config->stopbits = 1;
619 config->stopbits = 2;
622 config->stopbits = -1;
625 switch (data->dcb.fRtsControl) {
626 case RTS_CONTROL_DISABLE:
627 config->rts = SP_RTS_OFF;
629 case RTS_CONTROL_ENABLE:
630 config->rts = SP_RTS_ON;
632 case RTS_CONTROL_HANDSHAKE:
633 config->rts = SP_RTS_FLOW_CONTROL;
639 config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
641 switch (data->dcb.fDtrControl) {
642 case DTR_CONTROL_DISABLE:
643 config->dtr = SP_DTR_OFF;
645 case DTR_CONTROL_ENABLE:
646 config->dtr = SP_DTR_ON;
648 case DTR_CONTROL_HANDSHAKE:
649 config->dtr = SP_DTR_FLOW_CONTROL;
655 config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
657 if (data->dcb.fInX) {
659 config->xon_xoff = SP_XONXOFF_INOUT;
661 config->xon_xoff = SP_XONXOFF_IN;
664 config->xon_xoff = SP_XONXOFF_OUT;
666 config->xon_xoff = SP_XONXOFF_DISABLED;
671 if (tcgetattr(port->fd, &data->term) < 0)
674 if (ioctl(port->fd, TIOCMGET, &data->controlbits) < 0)
676 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
677 if (cfgetispeed(&data->term) == std_baudrates[i].index) {
678 config->baudrate = std_baudrates[i].value;
683 if (i == NUM_STD_BAUDRATES)
684 config->baudrate = -1;
686 switch (data->term.c_cflag & CSIZE) {
703 if (!(data->term.c_cflag & PARENB) && (data->term.c_iflag & IGNPAR))
704 config->parity = SP_PARITY_NONE;
705 else if (!(data->term.c_cflag & PARENB) || (data->term.c_iflag & IGNPAR))
708 config->parity = (data->term.c_cflag & PARODD) ? SP_PARITY_ODD : SP_PARITY_EVEN;
710 config->stopbits = (data->term.c_cflag & CSTOPB) ? 2 : 1;
712 if (data->term.c_cflag & CRTSCTS) {
713 config->rts = SP_RTS_FLOW_CONTROL;
714 config->cts = SP_CTS_FLOW_CONTROL;
716 config->rts = (data->controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
717 config->cts = SP_CTS_IGNORE;
720 config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
721 config->dsr = SP_DSR_IGNORE;
727 static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp_port_config *config)
732 if (config->baudrate >= 0)
734 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
735 if (config->baudrate == std_baudrates[i].value) {
736 data->dcb.BaudRate = std_baudrates[i].index;
741 if (i == NUM_STD_BAUDRATES)
742 data->dcb.BaudRate = config->baudrate;
745 if (config->bits >= 0)
746 data->dcb.ByteSize = config->bits;
748 if (config->parity >= 0) {
749 switch (config->parity) {
750 /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
752 data->dcb.Parity = NOPARITY;
755 data->dcb.Parity = EVENPARITY;
758 data->dcb.Parity = ODDPARITY;
765 if (config->stopbits >= 0) {
766 switch (config->stopbits) {
767 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
769 data->dcb.StopBits = ONESTOPBIT;
772 data->dcb.StopBits = TWOSTOPBITS;
779 if (config->rts >= 0) {
780 switch (config->rts) {
782 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
785 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
787 case SP_RTS_FLOW_CONTROL:
788 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
795 if (config->cts >= 0) {
796 switch (config->cts) {
798 data->dcb.fOutxCtsFlow = FALSE;
800 case SP_CTS_FLOW_CONTROL:
801 data->dcb.fOutxCtsFlow = TRUE;
808 if (config->dtr >= 0) {
809 switch (config->dtr) {
811 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
814 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
816 case SP_DTR_FLOW_CONTROL:
817 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
824 if (config->dsr >= 0) {
825 switch (config->dsr) {
827 data->dcb.fOutxDsrFlow = FALSE;
829 case SP_DSR_FLOW_CONTROL:
830 data->dcb.fOutxDsrFlow = TRUE;
837 if (config->xon_xoff >= 0) {
838 switch (config->xon_xoff) {
839 case SP_XONXOFF_DISABLED:
840 data->dcb.fInX = FALSE;
841 data->dcb.fOutX = FALSE;
844 data->dcb.fInX = TRUE;
845 data->dcb.fOutX = FALSE;
848 data->dcb.fInX = FALSE;
849 data->dcb.fOutX = TRUE;
851 case SP_XONXOFF_INOUT:
852 data->dcb.fInX = TRUE;
853 data->dcb.fOutX = TRUE;
860 if (!SetCommState(port->hdl, &data->dcb))
865 if (config->baudrate >= 0)
867 for (i = 0; i < NUM_STD_BAUDRATES; i++) {
868 if (config->baudrate == std_baudrates[i].value) {
869 if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
872 if (cfsetispeed(&data->term, std_baudrates[i].index) < 0)
878 if (i == NUM_STD_BAUDRATES)
882 if (config->bits >= 0) {
883 data->term.c_cflag &= ~CSIZE;
884 switch (config->bits) {
886 data->term.c_cflag |= CS8;
889 data->term.c_cflag |= CS7;
892 data->term.c_cflag |= CS6;
899 if (config->parity >= 0) {
900 data->term.c_iflag &= ~IGNPAR;
901 data->term.c_cflag &= ~(PARENB | PARODD);
902 switch (config->parity) {
904 data->term.c_iflag |= IGNPAR;
907 data->term.c_cflag |= PARENB;
910 data->term.c_cflag |= PARENB | PARODD;
917 if (config->stopbits >= 0) {
918 data->term.c_cflag &= ~CSTOPB;
919 switch (config->stopbits) {
921 data->term.c_cflag &= ~CSTOPB;
924 data->term.c_cflag |= CSTOPB;
931 if (config->rts >= 0 || config->cts >= 0)
933 /* Asymmetric use of RTS/CTS not supported yet. */
935 if (data->term.c_iflag & CRTSCTS) {
936 /* Flow control can only be disabled for both RTS & CTS together. */
937 if (config->rts >= 0 && config->rts != SP_RTS_FLOW_CONTROL) {
938 if (config->cts != SP_CTS_IGNORE)
941 if (config->cts >= 0 && config->cts != SP_CTS_FLOW_CONTROL) {
942 if (config->rts <= 0 || config->rts == SP_RTS_FLOW_CONTROL)
946 /* Flow control can only be enabled for both RTS & CTS together. */
947 if (((config->rts == SP_RTS_FLOW_CONTROL) && (config->cts != SP_CTS_FLOW_CONTROL)) ||
948 ((config->cts == SP_CTS_FLOW_CONTROL) && (config->rts != SP_RTS_FLOW_CONTROL)))
952 if (config->rts >= 0) {
953 if (config->rts == SP_RTS_FLOW_CONTROL) {
954 data->term.c_iflag |= CRTSCTS;
956 int controlbits = TIOCM_RTS;
957 if (ioctl(port->fd, config->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
964 if (config->dtr >= 0 || config->dsr >= 0)
966 /* DTR/DSR flow control not supported yet. */
967 if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
970 if (config->dtr >= 0) {
971 int controlbits = TIOCM_DTR;
972 if (ioctl(port->fd, config->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
978 if (config->xon_xoff >= 0) {
979 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
980 switch (config->xon_xoff) {
981 case SP_XONXOFF_DISABLED:
984 data->term.c_iflag |= IXOFF;
987 data->term.c_iflag |= IXON | IXANY;
989 case SP_XONXOFF_INOUT:
990 data->term.c_iflag |= IXON | IXOFF | IXANY;
997 if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0)
1004 #define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0)
1006 int sp_set_config(struct sp_port *port, struct sp_port_config *config)
1008 struct sp_port_data data;
1009 struct sp_port_config prev_config;
1011 TRY(get_config(port, &data, &prev_config));
1012 TRY(set_config(port, &data, config));
1017 #define CREATE_SETTER(x) int sp_set_##x(struct sp_port *port, int x) { \
1018 struct sp_port_data data; \
1019 struct sp_port_config config; \
1020 TRY(get_config(port, &data, &config)); \
1022 TRY(set_config(port, &data, &config)); \
1026 CREATE_SETTER(baudrate)
1028 CREATE_SETTER(parity)
1029 CREATE_SETTER(stopbits)
1034 CREATE_SETTER(xon_xoff)
1036 int sp_set_flowcontrol(struct sp_port *port, int flowcontrol)
1038 struct sp_port_data data;
1039 struct sp_port_config config;
1041 TRY(get_config(port, &data, &config));
1043 if (flowcontrol == SP_FLOWCONTROL_XONXOFF)
1044 config.xon_xoff = SP_XONXOFF_INOUT;
1046 config.xon_xoff = SP_XONXOFF_DISABLED;
1048 if (flowcontrol == SP_FLOWCONTROL_RTSCTS) {
1049 config.rts = SP_RTS_FLOW_CONTROL;
1050 config.cts = SP_CTS_FLOW_CONTROL;
1052 if (config.rts == SP_RTS_FLOW_CONTROL)
1053 config.rts = SP_RTS_ON;
1054 config.cts = SP_CTS_IGNORE;
1057 if (flowcontrol == SP_FLOWCONTROL_DTRDSR) {
1058 config.dtr = SP_DTR_FLOW_CONTROL;
1059 config.dsr = SP_DSR_FLOW_CONTROL;
1061 if (config.dtr == SP_DTR_FLOW_CONTROL)
1062 config.dtr = SP_DTR_ON;
1063 config.dsr = SP_DSR_IGNORE;
1066 TRY(set_config(port, &data, &config));
1071 int sp_last_error_code(void)
1074 return GetLastError();
1080 char *sp_last_error_message(void)
1084 DWORD error = GetLastError();
1087 FORMAT_MESSAGE_ALLOCATE_BUFFER |
1088 FORMAT_MESSAGE_FROM_SYSTEM |
1089 FORMAT_MESSAGE_IGNORE_INSERTS,
1092 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1098 return strerror(errno);
1102 void sp_free_error_message(char *message)