]> sigrok.org Git - libserialport.git/blobdiff - serialport.c
On Windows, prefix port names with '\\.\' to work with ports above COM9.
[libserialport.git] / serialport.c
index c89f44ea89ecc2318401a4d97a03e4d36e95daef..c891006ea19a622bc27d1794f8207ea142bd5c75 100644 (file)
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <unistd.h>
+#include <stdlib.h>
+#include <errno.h>
 #ifdef _WIN32
 #include <windows.h>
+#include <tchar.h>
 #else
-#include <glob.h>
 #include <termios.h>
 #include <sys/ioctl.h>
 #endif
-#include <stdlib.h>
-#include <errno.h>
+#ifdef __APPLE__
+#include <IOKit/IOKitLib.h>
+#include <IOKit/serial/IOSerialKeys.h>
+#include <sys/syslimits.h>
+#endif
+#ifdef __linux__
+#include "libudev.h"
+#include "linux/serial.h"
+#endif
+
+#include "libserialport.h"
+
+int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
+{
+       struct sp_port *port;
+       int len;
+
+       *port_ptr = NULL;
+
+       if (!portname)
+               return SP_ERR_ARG;
+
+       if (!(port = malloc(sizeof(struct sp_port))))
+               return SP_ERR_MEM;
 
-#include "serialport.h"
+       len = strlen(portname) + 1;
+
+       if (!(port->name = malloc(len)))
+       {
+               free(port);
+               return SP_ERR_MEM;
+       }
+
+       memcpy(port->name, portname, len);
+
+       *port_ptr = port;
+
+       return SP_OK;
+}
+
+void sp_free_port(struct sp_port *port)
+{
+       if (!port)
+               return;
+
+       if (port->name)
+               free(port->name);
+
+       free(port);
+}
+
+static struct sp_port **sp_list_append(struct sp_port **list, const char *portname)
+{
+       void *tmp;
+       unsigned int count;
+       for (count = 0; list[count]; count++);
+       if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
+               goto fail;
+       list = tmp;
+       if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
+               goto fail;
+       list[count + 1] = NULL;
+       return list;
+fail:
+       sp_free_port_list(list);
+       return NULL;
+}
+
+int sp_list_ports(struct sp_port ***list_ptr)
+{
+       struct sp_port **list;
+       int ret = SP_OK;
+
+       if (!(list = malloc(sizeof(struct sp_port **))))
+               return SP_ERR_MEM;;
+
+       list[0] = NULL;
+
+#ifdef _WIN32
+       HKEY key;
+       TCHAR *value, *data;
+       DWORD max_value_len, max_data_size, max_data_len;
+       DWORD value_len, data_size, data_len;
+       DWORD type, index = 0;
+       char *name;
+       int name_len;
+
+       if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
+                       0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS)
+       {
+               ret = SP_ERR_FAIL;
+               goto out_done;
+       }
+       if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
+                               &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS)
+       {
+               ret = SP_ERR_FAIL;
+               goto out_close;
+       }
+       max_data_len = max_data_size / sizeof(TCHAR);
+       if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR))))
+       {
+               ret = SP_ERR_MEM;
+               goto out_close;
+       }
+       if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR))))
+       {
+               ret = SP_ERR_MEM;
+               goto out_free_value;
+       }
+       while (
+               value_len = max_value_len + 1,
+               data_size = max_data_size,
+               RegEnumValue(key, index, value, &value_len,
+                       NULL, &type, (LPBYTE)data, &data_size) == ERROR_SUCCESS)
+       {
+               data_len = data_size / sizeof(TCHAR);
+               data[data_len] = '\0';
+#ifdef UNICODE
+               name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL)
+#else
+               name_len = data_len + 1;
+#endif
+               if (!(name = malloc(name_len)))
+               {
+                       ret = SP_ERR_MEM;
+                       goto out;
+               }
+#ifdef UNICODE
+               WideCharToMultiByte(CP_ACP, 0, data, -1, name, name_len, NULL, NULL);
+#else
+               strcpy(name, data);
+#endif
+               if (type == REG_SZ && !(list = sp_list_append(list, name)))
+               {
+                       ret = SP_ERR_MEM;
+                       goto out;
+               }
+               index++;
+       }
+out:
+       free(data);
+out_free_value:
+       free(value);
+out_close:
+       RegCloseKey(key);
+out_done:
+#endif
+#ifdef __APPLE__
+       mach_port_t master;
+       CFMutableDictionaryRef classes;
+       io_iterator_t iter;
+       char *path;
+       io_object_t port;
+       CFTypeRef cf_path;
+       Boolean result;
+
+       if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS)
+       {
+               ret = SP_ERR_FAIL;
+               goto out_done;
+       }
+
+       if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue)))
+       {
+               ret = SP_ERR_FAIL;
+               goto out_done;
+       }
+
+       CFDictionarySetValue(classes,
+                       CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
+
+       if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS)
+       {
+               ret = SP_ERR_FAIL;
+               goto out_done;
+       }
+
+       if (!(path = malloc(PATH_MAX)))
+       {
+               ret = SP_ERR_MEM;
+               goto out_release;
+       }
+
+       while ((port = IOIteratorNext(iter))) {
+               cf_path = IORegistryEntryCreateCFProperty(port,
+                               CFSTR(kIOCalloutDeviceKey), kCFAllocatorDefault, 0);
+               if (cf_path) {
+                       result = CFStringGetCString(cf_path,
+                                       path, PATH_MAX, kCFStringEncodingASCII);
+                       CFRelease(cf_path);
+                       if (result && !(list = sp_list_append(list, path)))
+                       {
+                               ret = SP_ERR_MEM;
+                               IOObjectRelease(port);
+                               goto out;
+                       }
+               }
+               IOObjectRelease(port);
+       }
+out:
+       free(path);
+out_release:
+       IOObjectRelease(iter);
+out_done:
+#endif
+#ifdef __linux__
+       struct udev *ud;
+       struct udev_enumerate *ud_enumerate;
+       struct udev_list_entry *ud_list;
+       struct udev_list_entry *ud_entry;
+       const char *path;
+       struct udev_device *ud_dev, *ud_parent;
+       const char *name;
+       const char *driver;
+       int fd, ioctl_result;
+       struct serial_struct serial_info;
+
+       ud = udev_new();
+       ud_enumerate = udev_enumerate_new(ud);
+       udev_enumerate_add_match_subsystem(ud_enumerate, "tty");
+       udev_enumerate_scan_devices(ud_enumerate);
+       ud_list = udev_enumerate_get_list_entry(ud_enumerate);
+       udev_list_entry_foreach(ud_entry, ud_list)
+       {
+               path = udev_list_entry_get_name(ud_entry);
+               ud_dev = udev_device_new_from_syspath(ud, path);
+               /* If there is no parent device, this is a virtual tty. */
+               ud_parent = udev_device_get_parent(ud_dev);
+               if (ud_parent == NULL)
+               {
+                       udev_device_unref(ud_dev);
+                       continue;
+               }
+               name = udev_device_get_devnode(ud_dev);
+               /* The serial8250 driver has a hardcoded number of ports.
+                * The only way to tell which actually exist on a given system
+                * is to try to open them and make an ioctl call. */
+               driver = udev_device_get_driver(ud_parent);
+               if (driver && !strcmp(driver, "serial8250"))
+               {
+                       if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0)
+                               goto skip;
+                       ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
+                       close(fd);
+                       if (ioctl_result != 0)
+                               goto skip;
+                       if (serial_info.type == PORT_UNKNOWN)
+                               goto skip;
+               }
+               list = sp_list_append(list, name);
+skip:
+               udev_device_unref(ud_dev);
+               if (!list)
+               {
+                       ret = SP_ERR_MEM;
+                       goto out;
+               }
+       }
+out:
+       udev_enumerate_unref(ud_enumerate);
+       udev_unref(ud);
+#endif
+
+       if (ret == SP_OK)
+       {
+               *list_ptr = list;
+       }
+       else
+       {
+               if (list)
+                       sp_free_port_list(list);
+
+               *list_ptr = NULL;
+       }
+
+       return ret;
+}
+
+void sp_free_port_list(struct sp_port **list)
+{
+       unsigned int i;
+       for (i = 0; list[i]; i++)
+               sp_free_port(list[i]);
+       free(list);
+}
 
 static int sp_validate_port(struct sp_port *port)
 {
@@ -52,29 +336,20 @@ static int sp_validate_port(struct sp_port *port)
 
 #define CHECK_PORT() do { if (!sp_validate_port(port)) return SP_ERR_ARG; } while (0)
 
-/**
- * Open the specified serial port.
- *
- * @param port Pointer to empty port structure allocated by caller.
- * @param portname Name of port to open.
- * @param flags Flags to use when opening the serial port. Possible flags
- *              are: SP_MODE_RDWR, SP_MODE_RDONLY, SP_MODE_NONBLOCK.
- *
- * @return SP_OK on success, SP_ERR_FAIL on failure,
- *         or SP_ERR_ARG if an invalid port or name is passed.
- */
-int sp_open(struct sp_port *port, char *portname, int flags)
+int sp_open(struct sp_port *port, int flags)
 {
        if (!port)
                return SP_ERR_ARG;
 
-       if (!portname)
-               return SP_ERR_ARG;
-
-       port->name = portname;
-
 #ifdef _WIN32
        DWORD desired_access = 0, flags_and_attributes = 0;
+       char *escaped_port_name;
+
+       /* Prefix port name with '\\.\' to work with ports above COM9. */
+       if (!(escaped_port_name = malloc(strlen(port->name + 5))))
+               return SP_ERR_MEM;
+       sprintf(escaped_port_name, "\\\\.\\%s", port->name);
+
        /* Map 'flags' to the OS-specific settings. */
        desired_access |= GENERIC_READ;
        flags_and_attributes = FILE_ATTRIBUTE_NORMAL;
@@ -83,8 +358,11 @@ int sp_open(struct sp_port *port, char *portname, int flags)
        if (flags & SP_MODE_NONBLOCK)
                flags_and_attributes |= FILE_FLAG_OVERLAPPED;
 
-       port->hdl = CreateFile(port->name, desired_access, 0, 0,
+       port->hdl = CreateFile(escaped_port_name, desired_access, 0, 0,
                         OPEN_EXISTING, flags_and_attributes, 0);
+
+       free(escaped_port_name);
+
        if (port->hdl == INVALID_HANDLE_VALUE)
                return SP_ERR_FAIL;
 #else
@@ -104,14 +382,6 @@ int sp_open(struct sp_port *port, char *portname, int flags)
        return SP_OK;
 }
 
-/**
- * Close the specified serial port.
- *
- * @param port Pointer to port structure.
- *
- * @return SP_OK on success, SP_ERR_FAIL on failure,
- *         or SP_ERR_ARG if an invalid port is passed.
- */
 int sp_close(struct sp_port *port)
 {
        CHECK_PORT();
@@ -129,14 +399,6 @@ int sp_close(struct sp_port *port)
        return SP_OK;
 }
 
-/**
- * Flush serial port buffers.
- *
- * @param port Pointer to port structure.
- *
- * @return SP_OK on success, SP_ERR_FAIL on failure,
- *         or SP_ERR_ARG if an invalid port is passed.
- */
 int sp_flush(struct sp_port *port)
 {
        CHECK_PORT();
@@ -153,16 +415,6 @@ int sp_flush(struct sp_port *port)
        return SP_OK;
 }
 
-/**
- * Write a number of bytes to the specified serial port.
- *
- * @param port Pointer to port structure.
- * @param buf Buffer containing the bytes to write.
- * @param count Number of bytes to write.
- *
- * @return The number of bytes written, SP_ERR_FAIL on failure,
- *         or SP_ERR_ARG if an invalid port is passed.
- */
 int sp_write(struct sp_port *port, const void *buf, size_t count)
 {
        CHECK_PORT();
@@ -186,16 +438,6 @@ int sp_write(struct sp_port *port, const void *buf, size_t count)
 #endif
 }
 
-/**
- * Read a number of bytes from the specified serial port.
- *
- * @param port Pointer to port structure.
- * @param buf Buffer where to store the bytes that are read.
- * @param count The number of bytes to read.
- *
- * @return The number of bytes read, SP_ERR_FAIL on failure,
- *         or SP_ERR_ARG if an invalid port is passed.
- */
 int sp_read(struct sp_port *port, void *buf, size_t count)
 {
        CHECK_PORT();
@@ -218,20 +460,6 @@ int sp_read(struct sp_port *port, void *buf, size_t count)
 #endif
 }
 
-/**
- * Set serial parameters for the specified serial port.
- *
- * @param port Pointer to port structure.
- * @param baudrate The baudrate to set.
- * @param bits The number of data bits to use.
- * @param parity The parity setting to use (0 = none, 1 = even, 2 = odd).
- * @param stopbits The number of stop bits to use (1 or 2).
- * @param flowcontrol The flow control settings to use (0 = none, 1 = RTS/CTS,
- *                    2 = XON/XOFF).
- *
- * @return The number of bytes read, SP_ERR_FAIL on failure,
- *         or SP_ERR_ARG if an invalid argument is passed.
- */
 int sp_set_params(struct sp_port *port, int baudrate,
                              int bits, int parity, int stopbits,
                              int flowcontrol, int rts, int dtr)
@@ -440,7 +668,7 @@ int sp_set_params(struct sp_port *port, int baudrate,
                return SP_ERR_ARG;
        }
 
-       term.c_iflag &= ~(IXON | IXOFF);
+       term.c_iflag &= ~(IXON | IXOFF | IXANY);
        term.c_cflag &= ~CRTSCTS;
        switch (flowcontrol) {
        case 0:
@@ -450,14 +678,14 @@ int sp_set_params(struct sp_port *port, int baudrate,
                term.c_cflag |= CRTSCTS;
                break;
        case 2:
-               term.c_iflag |= IXON | IXOFF;
+               term.c_iflag |= IXON | IXOFF | IXANY;
                break;
        default:
                return SP_ERR_ARG;
        }
 
        term.c_iflag &= ~IGNPAR;
-       term.c_cflag &= ~(PARODD | PARENB);
+       term.c_cflag &= ~(PARENB | PARODD);
        switch (parity) {
        case SP_PARITY_NONE:
                term.c_iflag |= IGNPAR;
@@ -482,6 +710,9 @@ int sp_set_params(struct sp_port *port, int baudrate,
        /* Disable canonical mode, and don't echo input characters. */
        term.c_lflag &= ~(ICANON | ECHO);
 
+       /* Ignore modem status lines; enable receiver */
+       term.c_cflag |= (CLOCAL | CREAD);
+
        /* Write the configured settings. */
        if (tcsetattr(port->fd, TCSADRAIN, &term) < 0)
                return SP_ERR_FAIL;
@@ -504,15 +735,6 @@ int sp_set_params(struct sp_port *port, int baudrate,
        return SP_OK;
 }
 
-/**
- * Get error code for failed operation.
- *
- * In order to obtain the correct result, this function should be called
- * straight after the failure, before executing any other system operations.
- *
- * @return The system's numeric code for the error that caused the last
- *         operation to fail.
- */
 int sp_last_error_code(void)
 {
 #ifdef _WIN32
@@ -522,16 +744,6 @@ int sp_last_error_code(void)
 #endif
 }
 
-/**
- * Get error message for failed operation.
- *
- * In order to obtain the correct result, this function should be called
- * straight after the failure, before executing other system operations.
- *
- * @return The system's message for the error that caused the last
- *         operation to fail. This string may be allocated by the function,
- *         and can be freed after use by calling sp_free_error_message.
- */
 char *sp_last_error_message(void)
 {
 #ifdef _WIN32
@@ -554,15 +766,11 @@ char *sp_last_error_message(void)
 #endif
 }
 
-/**
- * Free error message.
- *
- * This function can be used to free a string returned by the
- * sp_last_error_message function.
- */
 void sp_free_error_message(char *message)
 {
 #ifdef _WIN32
        LocalFree(message);
+#else
+       (void)message;
 #endif
 }