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"
61 int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
74 if (!(port = malloc(sizeof(struct sp_port))))
77 len = strlen(portname) + 1;
79 if (!(port->name = malloc(len)))
85 memcpy(port->name, portname, len);
92 int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
99 if (!port || !port->name)
102 return sp_get_port_by_name(port->name, copy_ptr);
105 void sp_free_port(struct sp_port *port)
116 static struct sp_port **sp_list_append(struct sp_port **list, const char *portname)
121 for (count = 0; list[count]; count++);
122 if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
125 if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
127 list[count + 1] = NULL;
131 sp_free_port_list(list);
135 int sp_list_ports(struct sp_port ***list_ptr)
137 struct sp_port **list;
140 if (!(list = malloc(sizeof(struct sp_port **))))
148 DWORD max_value_len, max_data_size, max_data_len;
149 DWORD value_len, data_size, data_len;
150 DWORD type, index = 0;
154 if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
155 0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS)
160 if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
161 &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS)
166 max_data_len = max_data_size / sizeof(TCHAR);
167 if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR))))
172 if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR))))
178 value_len = max_value_len + 1,
179 data_size = max_data_size,
180 RegEnumValue(key, index, value, &value_len,
181 NULL, &type, (LPBYTE)data, &data_size) == ERROR_SUCCESS)
183 data_len = data_size / sizeof(TCHAR);
184 data[data_len] = '\0';
186 name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
188 name_len = data_len + 1;
190 if (!(name = malloc(name_len)))
196 WideCharToMultiByte(CP_ACP, 0, data, -1, name, name_len, NULL, NULL);
200 if (type == REG_SZ && !(list = sp_list_append(list, name)))
217 CFMutableDictionaryRef classes;
224 if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS)
230 if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue)))
236 CFDictionarySetValue(classes,
237 CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
239 if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS)
245 if (!(path = malloc(PATH_MAX)))
251 while ((port = IOIteratorNext(iter))) {
252 cf_path = IORegistryEntryCreateCFProperty(port,
253 CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
255 result = CFStringGetCString(cf_path,
256 path, PATH_MAX, kCFStringEncodingASCII);
258 if (result && !(list = sp_list_append(list, path)))
261 IOObjectRelease(port);
265 IOObjectRelease(port);
270 IOObjectRelease(iter);
275 struct udev_enumerate *ud_enumerate;
276 struct udev_list_entry *ud_list;
277 struct udev_list_entry *ud_entry;
279 struct udev_device *ud_dev, *ud_parent;
282 int fd, ioctl_result;
283 struct serial_struct serial_info;
286 ud_enumerate = udev_enumerate_new(ud);
287 udev_enumerate_add_match_subsystem(ud_enumerate, "tty");
288 udev_enumerate_scan_devices(ud_enumerate);
289 ud_list = udev_enumerate_get_list_entry(ud_enumerate);
290 udev_list_entry_foreach(ud_entry, ud_list)
292 path = udev_list_entry_get_name(ud_entry);
293 ud_dev = udev_device_new_from_syspath(ud, path);
294 /* If there is no parent device, this is a virtual tty. */
295 ud_parent = udev_device_get_parent(ud_dev);
296 if (ud_parent == NULL)
298 udev_device_unref(ud_dev);
301 name = udev_device_get_devnode(ud_dev);
302 /* The serial8250 driver has a hardcoded number of ports.
303 * The only way to tell which actually exist on a given system
304 * is to try to open them and make an ioctl call. */
305 driver = udev_device_get_driver(ud_parent);
306 if (driver && !strcmp(driver, "serial8250"))
308 if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0)
310 ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
312 if (ioctl_result != 0)
314 if (serial_info.type == PORT_UNKNOWN)
317 list = sp_list_append(list, name);
319 udev_device_unref(ud_dev);
327 udev_enumerate_unref(ud_enumerate);
338 sp_free_port_list(list);
346 void sp_free_port_list(struct sp_port **list)
350 for (i = 0; list[i]; i++)
351 sp_free_port(list[i]);
355 static int sp_validate_port(struct sp_port *port)
360 if (port->hdl == INVALID_HANDLE_VALUE)
369 #define CHECK_PORT() do { if (!sp_validate_port(port)) return SP_ERR_ARG; } while (0)
371 int sp_open(struct sp_port *port, int flags)
377 DWORD desired_access = 0, flags_and_attributes = 0;
378 char *escaped_port_name;
380 /* Prefix port name with '\\.\' to work with ports above COM9. */
381 if (!(escaped_port_name = malloc(strlen(port->name + 5))))
383 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
385 /* Map 'flags' to the OS-specific settings. */
386 desired_access |= GENERIC_READ;
387 flags_and_attributes = FILE_ATTRIBUTE_NORMAL;
388 if (flags & SP_MODE_RDWR)
389 desired_access |= GENERIC_WRITE;
390 if (flags & SP_MODE_NONBLOCK)
391 flags_and_attributes |= FILE_FLAG_OVERLAPPED;
393 port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
394 OPEN_EXISTING, flags_and_attributes, 0);
396 free(escaped_port_name);
398 if (port->hdl == INVALID_HANDLE_VALUE)
403 /* Map 'flags' to the OS-specific settings. */
404 if (flags & SP_MODE_RDWR)
405 flags_local |= O_RDWR;
406 if (flags & SP_MODE_RDONLY)
407 flags_local |= O_RDONLY;
408 if (flags & SP_MODE_NONBLOCK)
409 flags_local |= O_NONBLOCK;
411 if ((port->fd = open(port->name, flags_local)) < 0)
418 int sp_close(struct sp_port *port)
423 /* Returns non-zero upon success, 0 upon failure. */
424 if (CloseHandle(port->hdl) == 0)
427 /* Returns 0 upon success, -1 upon failure. */
428 if (close(port->fd) == -1)
435 int sp_flush(struct sp_port *port)
440 /* Returns non-zero upon success, 0 upon failure. */
441 if (PurgeComm(port->hdl, PURGE_RXCLEAR | PURGE_TXCLEAR) == 0)
444 /* Returns 0 upon success, -1 upon failure. */
445 if (tcflush(port->fd, TCIOFLUSH) < 0)
451 int sp_write(struct sp_port *port, const void *buf, size_t count)
461 /* Returns non-zero upon success, 0 upon failure. */
462 if (WriteFile(port->hdl, buf, count, &written, NULL) == 0)
466 /* Returns the number of bytes written, or -1 upon failure. */
467 ssize_t written = write(port->fd, buf, count);
476 int sp_read(struct sp_port *port, void *buf, size_t count)
484 DWORD bytes_read = 0;
486 /* Returns non-zero upon success, 0 upon failure. */
487 if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0)
493 /* Returns the number of bytes read, or -1 upon failure. */
494 if ((bytes_read = read(port->fd, buf, count)) < 0)
500 static int start_config(struct sp_port *port, struct sp_port_data *data)
504 if (!GetCommState(port->hdl, &data->dcb))
507 if (tcgetattr(port->fd, &data->term) < 0)
513 static int set_baudrate(struct sp_port_data *data, int baudrate)
518 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
519 * have documented CBR_* macros.
522 data->dcb.BaudRate = CBR_110;
525 data->dcb.BaudRate = CBR_300;
528 data->dcb.BaudRate = CBR_600;
531 data->dcb.BaudRate = CBR_1200;
534 data->dcb.BaudRate = CBR_2400;
537 data->dcb.BaudRate = CBR_4800;
540 data->dcb.BaudRate = CBR_9600;
543 data->dcb.BaudRate = CBR_14400; /* Not available on Unix? */
546 data->dcb.BaudRate = CBR_19200;
549 data->dcb.BaudRate = CBR_38400;
552 data->dcb.BaudRate = CBR_57600;
555 data->dcb.BaudRate = CBR_115200;
558 data->dcb.BaudRate = CBR_128000; /* Not available on Unix? */
561 data->dcb.BaudRate = CBR_256000; /* Not available on Unix? */
623 #if !defined(__APPLE__) && !defined(__OpenBSD__)
632 if (cfsetospeed(&data->term, baud) < 0)
635 if (cfsetispeed(&data->term, baud) < 0)
642 static int set_bits(struct sp_port_data *data, int bits)
645 data->dcb.ByteSize = bits;
647 data->term.c_cflag &= ~CSIZE;
650 data->term.c_cflag |= CS8;
653 data->term.c_cflag |= CS7;
656 data->term.c_cflag |= CS6;
665 static int set_parity(struct sp_port_data *data, int parity)
669 /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
671 data->dcb.Parity = NOPARITY;
674 data->dcb.Parity = EVENPARITY;
677 data->dcb.Parity = ODDPARITY;
683 data->term.c_iflag &= ~IGNPAR;
684 data->term.c_cflag &= ~(PARENB | PARODD);
687 data->term.c_iflag |= IGNPAR;
690 data->term.c_cflag |= PARENB;
693 data->term.c_cflag |= PARENB | PARODD;
702 static int set_stopbits(struct sp_port_data *data, int stopbits)
706 /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
708 data->dcb.StopBits = ONESTOPBIT;
711 data->dcb.StopBits = TWOSTOPBITS;
717 data->term.c_cflag &= ~CSTOPB;
720 data->term.c_cflag &= ~CSTOPB;
723 data->term.c_cflag |= CSTOPB;
732 static int set_rts(struct sp_port_data *data, int rts)
737 data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
740 data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
742 case SP_RTS_FLOW_CONTROL:
743 data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
754 static int set_cts(struct sp_port_data *data, int cts)
759 data->dcb.fOutxCtsFlow = FALSE;
761 case SP_CTS_FLOW_CONTROL:
762 data->dcb.fOutxCtsFlow = TRUE;
773 static int set_dtr(struct sp_port_data *data, int dtr)
778 data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
781 data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
783 case SP_DTR_FLOW_CONTROL:
784 data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
795 static int set_dsr(struct sp_port_data *data, int dsr)
800 data->dcb.fOutxDsrFlow = FALSE;
802 case SP_DSR_FLOW_CONTROL:
803 data->dcb.fOutxDsrFlow = TRUE;
814 static int set_xon_xoff(struct sp_port_data *data, int xon_xoff)
818 case SP_XONXOFF_DISABLED:
819 data->dcb.fInX = FALSE;
820 data->dcb.fOutX = FALSE;
823 data->dcb.fInX = TRUE;
824 data->dcb.fOutX = FALSE;
827 data->dcb.fInX = FALSE;
828 data->dcb.fOutX = TRUE;
830 case SP_XONXOFF_INOUT:
831 data->dcb.fInX = TRUE;
832 data->dcb.fOutX = TRUE;
838 data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
840 case SP_XONXOFF_DISABLED:
843 data->term.c_iflag |= IXOFF;
846 data->term.c_iflag |= IXON | IXANY;
848 case SP_XONXOFF_INOUT:
849 data->term.c_iflag |= IXON | IXOFF | IXANY;
858 static int apply_config(struct sp_port *port, struct sp_port_data *data)
861 if (!SetCommState(port->hdl, &data->dcb))
866 /* Turn off all serial port cooking. */
867 data->term.c_iflag &= ~(ISTRIP | INLCR | ICRNL);
868 data->term.c_oflag &= ~(ONLCR | OCRNL | ONOCR);
869 #if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
870 data->term.c_oflag &= ~OFILL;
872 /* Disable canonical mode, and don't echo input characters. */
873 data->term.c_lflag &= ~(ICANON | ECHO);
875 /* Ignore modem status lines; enable receiver */
876 data->term.c_cflag |= (CLOCAL | CREAD);
878 /* Asymmetric use of RTS/CTS not supported yet. */
879 if ((data->rts == SP_RTS_FLOW_CONTROL) != (data->cts == SP_CTS_FLOW_CONTROL))
882 /* DTR/DSR flow control not supported yet. */
883 if (data->dtr == SP_DTR_FLOW_CONTROL || data->dsr == SP_DSR_FLOW_CONTROL)
886 if (data->rts == SP_RTS_FLOW_CONTROL)
887 data->term.c_iflag |= CRTSCTS;
890 controlbits = TIOCM_RTS;
891 if (ioctl(port->fd, data->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
896 controlbits = TIOCM_DTR;
897 if (ioctl(port->fd, data->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
901 /* Write the configured settings. */
902 if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0)
908 #define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0)
909 #define TRY_SET(x) do { if (config->x >= 0) TRY(set_##x(&data, config->x)); } while (0)
911 int sp_set_config(struct sp_port *port, struct sp_port_config *config)
913 struct sp_port_data data;
915 TRY(start_config(port, &data));
925 TRY(apply_config(port, &data));
930 int sp_last_error_code(void)
933 return GetLastError();
939 char *sp_last_error_message(void)
943 DWORD error = GetLastError();
946 FORMAT_MESSAGE_ALLOCATE_BUFFER |
947 FORMAT_MESSAGE_FROM_SYSTEM |
948 FORMAT_MESSAGE_IGNORE_INSERTS,
951 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
957 return strerror(errno);
961 void sp_free_error_message(char *message)