]> 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 93303767c05dfb512926c538cbb6748dcade4db6..c891006ea19a622bc27d1794f8207ea142bd5c75 100644 (file)
 #include "linux/serial.h"
 #endif
 
-#include "serialport.h"
+#include "libserialport.h"
 
-struct sp_port *sp_get_port_by_name(const char *portname)
+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 NULL;
+               return SP_ERR_ARG;
 
        if (!(port = malloc(sizeof(struct sp_port))))
-               return NULL;
+               return SP_ERR_MEM;
 
        len = strlen(portname) + 1;
 
        if (!(port->name = malloc(len)))
        {
                free(port);
-               return NULL;
+               return SP_ERR_MEM;
        }
 
        memcpy(port->name, portname, len);
 
-       return port;
+       *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)
@@ -77,7 +92,7 @@ static struct sp_port **sp_list_append(struct sp_port **list, const char *portna
        if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
                goto fail;
        list = tmp;
-       if (!(list[count] = sp_get_port_by_name(portname)))
+       if (sp_get_port_by_name(portname, &list[count]) != SP_OK)
                goto fail;
        list[count + 1] = NULL;
        return list;
@@ -86,17 +101,13 @@ fail:
        return NULL;
 }
 
-/**
- * List the serial ports available on the system.
- *
- * @return A null-terminated array of port name strings.
- */
-struct sp_port **sp_list_ports(void)
+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 NULL;
+               return SP_ERR_MEM;;
 
        list[0] = NULL;
 
@@ -111,17 +122,29 @@ struct sp_port **sp_list_ports(void)
 
        if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
                        0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS)
-               return NULL;
+       {
+               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,
+               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)
@@ -134,15 +157,20 @@ struct sp_port **sp_list_ports(void)
                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)
-                       if (!(list = sp_list_append(list, name)))
-                               goto out;
+               if (type == REG_SZ && !(list = sp_list_append(list, name)))
+               {
+                       ret = SP_ERR_MEM;
+                       goto out;
+               }
                index++;
        }
 out:
@@ -151,7 +179,7 @@ out_free_value:
        free(value);
 out_close:
        RegCloseKey(key);
-       return list;
+out_done:
 #endif
 #ifdef __APPLE__
        mach_port_t master;
@@ -163,19 +191,31 @@ out_close:
        Boolean result;
 
        if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS)
-               return NULL;
+       {
+               ret = SP_ERR_FAIL;
+               goto out_done;
+       }
 
        if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue)))
-               return NULL;
+       {
+               ret = SP_ERR_FAIL;
+               goto out_done;
+       }
 
        CFDictionarySetValue(classes,
                        CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
 
-       if (!(IOServiceGetMatchingServices(master, classes, &iter)))
-               return NULL;
+       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,
@@ -184,21 +224,20 @@ out_close:
                        result = CFStringGetCString(cf_path,
                                        path, PATH_MAX, kCFStringEncodingASCII);
                        CFRelease(cf_path);
-                       if (result)
-                               if (!(list = sp_list_append(list, path)))
-                               {
-                                       IOObjectRelease(port);
-                                       goto out;
-                               }
+                       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);
-       return list;
+out_done:
 #endif
 #ifdef __linux__
        struct udev *ud;
@@ -248,23 +287,36 @@ out_release:
 skip:
                udev_device_unref(ud_dev);
                if (!list)
+               {
+                       ret = SP_ERR_MEM;
                        goto out;
+               }
        }
 out:
        udev_enumerate_unref(ud_enumerate);
        udev_unref(ud);
-       return list;
 #endif
+
+       if (ret == SP_OK)
+       {
+               *list_ptr = list;
+       }
+       else
+       {
+               if (list)
+                       sp_free_port_list(list);
+
+               *list_ptr = NULL;
+       }
+
+       return ret;
 }
 
-/**
- * Free a port list returned by sp_list_ports.
- */
 void sp_free_port_list(struct sp_port **list)
 {
        unsigned int i;
        for (i = 0; list[i]; i++)
-               free(list[i]);
+               sp_free_port(list[i]);
        free(list);
 }
 
@@ -284,17 +336,6 @@ 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, int flags)
 {
        if (!port)
@@ -302,6 +343,13 @@ int sp_open(struct sp_port *port, int flags)
 
 #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;
@@ -310,8 +358,11 @@ int sp_open(struct sp_port *port, 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
@@ -331,14 +382,6 @@ int sp_open(struct sp_port *port, 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();
@@ -356,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();
@@ -380,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();
@@ -413,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();
@@ -445,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)
@@ -734,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
@@ -752,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
@@ -784,12 +766,6 @@ 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