]> sigrok.org Git - libserialport.git/blobdiff - serialport.c
Add functions for setting individual port parameters.
[libserialport.git] / serialport.c
index ddddb518be2b1b4b9cb38d0fd1ca178bb48a5400..6a6e305bb2988ecc20d421b9a1f1b576f33dd2b4 100644 (file)
@@ -29,6 +29,7 @@
 #ifdef _WIN32
 #include <windows.h>
 #include <tchar.h>
+#include <stdio.h>
 #else
 #include <termios.h>
 #include <sys/ioctl.h>
 
 #include "libserialport.h"
 
+struct sp_port_data {
+#ifdef _WIN32
+       DCB dcb;
+#else
+       struct termios term;
+       int rts;
+       int cts;
+       int dtr;
+       int dsr;
+#endif
+};
+
+/* Helper functions for configuring ports. */
+static int start_config(struct sp_port *port, struct sp_port_data *data);
+static int set_baudrate(struct sp_port_data *data, int baudrate);
+static int set_bits(struct sp_port_data *data, int bits);
+static int set_parity(struct sp_port_data *data, int parity);
+static int set_stopbits(struct sp_port_data *data, int stopbits);
+static int set_rts(struct sp_port_data *data, int rts);
+static int set_cts(struct sp_port_data *data, int cts);
+static int set_dtr(struct sp_port_data *data, int dtr);
+static int set_dsr(struct sp_port_data *data, int dsr);
+static int set_xon_xoff(struct sp_port_data *data, int xon_xoff);
+static int apply_config(struct sp_port *port, struct sp_port_data *data);
+
 int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
 {
        struct sp_port *port;
        int len;
 
+       if (!port_ptr)
+               return SP_ERR_ARG;
+
        *port_ptr = NULL;
 
        if (!portname)
@@ -73,6 +102,19 @@ int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
        return SP_OK;
 }
 
+int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
+{
+       if (!copy_ptr)
+               return SP_ERR_ARG;
+
+       *copy_ptr = NULL;
+
+       if (!port || !port->name)
+               return SP_ERR_ARG;
+
+       return sp_get_port_by_name(port->name, copy_ptr);
+}
+
 void sp_free_port(struct sp_port *port)
 {
        if (!port)
@@ -88,6 +130,7 @@ static struct sp_port **sp_list_append(struct sp_port **list, const char *portna
 {
        void *tmp;
        unsigned int count;
+
        for (count = 0; list[count]; count++);
        if (!(tmp = realloc(list, sizeof(struct sp_port *) * (count + 2))))
                goto fail;
@@ -96,6 +139,7 @@ static struct sp_port **sp_list_append(struct sp_port **list, const char *portna
                goto fail;
        list[count + 1] = NULL;
        return list;
+
 fail:
        sp_free_port_list(list);
        return NULL;
@@ -107,7 +151,7 @@ int sp_list_ports(struct sp_port ***list_ptr)
        int ret = SP_OK;
 
        if (!(list = malloc(sizeof(struct sp_port **))))
-               return SP_ERR_MEM;;
+               return SP_ERR_MEM;
 
        list[0] = NULL;
 
@@ -315,6 +359,7 @@ out:
 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);
@@ -343,6 +388,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;
@@ -351,12 +403,17 @@ 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
        int flags_local = 0;
+       struct sp_port_data data;
+
        /* Map 'flags' to the OS-specific settings. */
        if (flags & SP_MODE_RDWR)
                flags_local |= O_RDWR;
@@ -367,6 +424,22 @@ int sp_open(struct sp_port *port, int flags)
 
        if ((port->fd = open(port->name, flags_local)) < 0)
                return SP_ERR_FAIL;
+
+       start_config(port, &data);
+
+       /* Turn off all serial port cooking. */
+       data.term.c_iflag &= ~(ISTRIP | INLCR | ICRNL);
+       data.term.c_oflag &= ~(ONLCR | OCRNL | ONOCR);
+#if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
+       data.term.c_oflag &= ~OFILL;
+#endif
+       /* Disable canonical mode, and don't echo input characters. */
+       data.term.c_lflag &= ~(ICANON | ECHO);
+
+       /* Ignore modem status lines; enable receiver */
+       data.term.c_cflag |= (CLOCAL | CREAD);
+
+       apply_config(port, &data);
 #endif
 
        return SP_OK;
@@ -414,6 +487,7 @@ int sp_write(struct sp_port *port, const void *buf, size_t count)
 
 #ifdef _WIN32
        DWORD written = 0;
+
        /* Returns non-zero upon success, 0 upon failure. */
        if (WriteFile(port->hdl, buf, count, &written, NULL) == 0)
                return SP_ERR_FAIL;
@@ -421,10 +495,11 @@ int sp_write(struct sp_port *port, const void *buf, size_t count)
 #else
        /* Returns the number of bytes written, or -1 upon failure. */
        ssize_t written = write(port->fd, buf, count);
+
        if (written < 0)
                return SP_ERR_FAIL;
        else
-               return written;;
+               return written;
 #endif
 }
 
@@ -437,12 +512,14 @@ int sp_read(struct sp_port *port, void *buf, size_t count)
 
 #ifdef _WIN32
        DWORD bytes_read = 0;
+
        /* Returns non-zero upon success, 0 upon failure. */
        if (ReadFile(port->hdl, buf, count, &bytes_read, NULL) == 0)
                return SP_ERR_FAIL;
        return bytes_read;
 #else
        ssize_t bytes_read;
+
        /* Returns the number of bytes read, or -1 upon failure. */
        if ((bytes_read = read(port->fd, buf, count)) < 0)
                return SP_ERR_FAIL;
@@ -450,120 +527,90 @@ int sp_read(struct sp_port *port, void *buf, size_t count)
 #endif
 }
 
-int sp_set_params(struct sp_port *port, int baudrate,
-                             int bits, int parity, int stopbits,
-                             int flowcontrol, int rts, int dtr)
+static int start_config(struct sp_port *port, struct sp_port_data *data)
 {
        CHECK_PORT();
-
 #ifdef _WIN32
-       DCB dcb;
+       if (!GetCommState(port->hdl, &data->dcb))
+               return SP_ERR_FAIL;
+#else
+       int controlbits;
 
-       if (!GetCommState(port->hdl, &dcb))
+       if (tcgetattr(port->fd, &data->term) < 0)
                return SP_ERR_FAIL;
 
+       if (ioctl(port->fd, TIOCMGET, &controlbits) < 0)
+               return SP_ERR_FAIL;
+
+       if (data->term.c_cflag & CRTSCTS) {
+               data->rts = SP_RTS_FLOW_CONTROL;
+               data->cts = SP_CTS_FLOW_CONTROL;
+       } else {
+               data->rts = (controlbits & TIOCM_RTS) ? SP_RTS_ON : SP_RTS_OFF;
+               data->cts = SP_CTS_IGNORE;
+       }
+
+       data->dtr = (controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
+       data->dsr = SP_DSR_IGNORE;
+#endif
+       return SP_OK;
+}
+
+static int set_baudrate(struct sp_port_data *data, int baudrate)
+{
+#ifdef _WIN32
        switch (baudrate) {
        /*
         * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
         * have documented CBR_* macros.
         */
        case 110:
-               dcb.BaudRate = CBR_110;
+               data->dcb.BaudRate = CBR_110;
                break;
        case 300:
-               dcb.BaudRate = CBR_300;
+               data->dcb.BaudRate = CBR_300;
                break;
        case 600:
-               dcb.BaudRate = CBR_600;
+               data->dcb.BaudRate = CBR_600;
                break;
        case 1200:
-               dcb.BaudRate = CBR_1200;
+               data->dcb.BaudRate = CBR_1200;
                break;
        case 2400:
-               dcb.BaudRate = CBR_2400;
+               data->dcb.BaudRate = CBR_2400;
                break;
        case 4800:
-               dcb.BaudRate = CBR_4800;
+               data->dcb.BaudRate = CBR_4800;
                break;
        case 9600:
-               dcb.BaudRate = CBR_9600;
+               data->dcb.BaudRate = CBR_9600;
                break;
        case 14400:
-               dcb.BaudRate = CBR_14400; /* Not available on Unix? */
+               data->dcb.BaudRate = CBR_14400; /* Not available on Unix? */
                break;
        case 19200:
-               dcb.BaudRate = CBR_19200;
+               data->dcb.BaudRate = CBR_19200;
                break;
        case 38400:
-               dcb.BaudRate = CBR_38400;
+               data->dcb.BaudRate = CBR_38400;
                break;
        case 57600:
-               dcb.BaudRate = CBR_57600;
+               data->dcb.BaudRate = CBR_57600;
                break;
        case 115200:
-               dcb.BaudRate = CBR_115200;
+               data->dcb.BaudRate = CBR_115200;
                break;
        case 128000:
-               dcb.BaudRate = CBR_128000; /* Not available on Unix? */
+               data->dcb.BaudRate = CBR_128000; /* Not available on Unix? */
                break;
        case 256000:
-               dcb.BaudRate = CBR_256000; /* Not available on Unix? */
+               data->dcb.BaudRate = CBR_256000; /* Not available on Unix? */
                break;
        default:
                return SP_ERR_ARG;
        }
-
-       switch (stopbits) {
-       /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
-       case 1:
-               dcb.StopBits = ONESTOPBIT;
-               break;
-       case 2:
-               dcb.StopBits = TWOSTOPBITS;
-               break;
-       default:
-               return SP_ERR_ARG;
-       }
-
-       switch (parity) {
-       /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
-       case SP_PARITY_NONE:
-               dcb.Parity = NOPARITY;
-               break;
-       case SP_PARITY_EVEN:
-               dcb.Parity = EVENPARITY;
-               break;
-       case SP_PARITY_ODD:
-               dcb.Parity = ODDPARITY;
-               break;
-       default:
-               return SP_ERR_ARG;
-       }
-
-       if (rts != -1) {
-               if (rts)
-                       dcb.fRtsControl = RTS_CONTROL_ENABLE;
-               else
-                       dcb.fRtsControl = RTS_CONTROL_DISABLE;
-       }
-
-       if (dtr != -1) {
-               if (dtr)
-                       dcb.fDtrControl = DTR_CONTROL_ENABLE;
-               else
-                       dcb.fDtrControl = DTR_CONTROL_DISABLE;
-       }
-
-       if (!SetCommState(port->hdl, &dcb))
-               return SP_ERR_FAIL;
 #else
-       struct termios term;
        speed_t baud;
-       int controlbits;
-
-       if (tcgetattr(port->fd, &term) < 0)
-               return SP_ERR_FAIL;
-
        switch (baudrate) {
        case 50:
                baud = B50;
@@ -628,103 +675,310 @@ int sp_set_params(struct sp_port *port, int baudrate,
                return SP_ERR_ARG;
        }
 
-       if (cfsetospeed(&term, baud) < 0)
+       if (cfsetospeed(&data->term, baud) < 0)
                return SP_ERR_FAIL;
 
-       if (cfsetispeed(&term, baud) < 0)
+       if (cfsetispeed(&data->term, baud) < 0)
                return SP_ERR_FAIL;
 
-       term.c_cflag &= ~CSIZE;
+#endif
+       return SP_OK;
+}
+
+static int set_bits(struct sp_port_data *data, int bits)
+{
+#ifdef _WIN32
+       data->dcb.ByteSize = bits;
+#else
+       data->term.c_cflag &= ~CSIZE;
        switch (bits) {
        case 8:
-               term.c_cflag |= CS8;
+               data->term.c_cflag |= CS8;
                break;
        case 7:
-               term.c_cflag |= CS7;
+               data->term.c_cflag |= CS7;
+               break;
+       case 6:
+               data->term.c_cflag |= CS6;
+               break;
+       default:
+               return SP_ERR_ARG;
+       }
+#endif
+       return SP_OK;
+}
+
+static int set_parity(struct sp_port_data *data, int parity)
+{
+#ifdef _WIN32
+       switch (parity) {
+       /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
+       case SP_PARITY_NONE:
+               data->dcb.Parity = NOPARITY;
+               break;
+       case SP_PARITY_EVEN:
+               data->dcb.Parity = EVENPARITY;
+               break;
+       case SP_PARITY_ODD:
+               data->dcb.Parity = ODDPARITY;
+               break;
+       default:
+               return SP_ERR_ARG;
+       }
+#else
+       data->term.c_iflag &= ~IGNPAR;
+       data->term.c_cflag &= ~(PARENB | PARODD);
+       switch (parity) {
+       case SP_PARITY_NONE:
+               data->term.c_iflag |= IGNPAR;
+               break;
+       case SP_PARITY_EVEN:
+               data->term.c_cflag |= PARENB;
+               break;
+       case SP_PARITY_ODD:
+               data->term.c_cflag |= PARENB | PARODD;
                break;
        default:
                return SP_ERR_ARG;
        }
+#endif
+       return SP_OK;
+}
 
-       term.c_cflag &= ~CSTOPB;
+static int set_stopbits(struct sp_port_data *data, int stopbits)
+{
+#ifdef _WIN32
        switch (stopbits) {
+       /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
        case 1:
-               term.c_cflag &= ~CSTOPB;
+               data->dcb.StopBits = ONESTOPBIT;
                break;
        case 2:
-               term.c_cflag |= CSTOPB;
+               data->dcb.StopBits = TWOSTOPBITS;
                break;
        default:
                return SP_ERR_ARG;
        }
-
-       term.c_iflag &= ~(IXON | IXOFF | IXANY);
-       term.c_cflag &= ~CRTSCTS;
-       switch (flowcontrol) {
-       case 0:
-               /* No flow control. */
-               break;
+#else
+       data->term.c_cflag &= ~CSTOPB;
+       switch (stopbits) {
        case 1:
-               term.c_cflag |= CRTSCTS;
+               data->term.c_cflag &= ~CSTOPB;
                break;
        case 2:
-               term.c_iflag |= IXON | IXOFF | IXANY;
+               data->term.c_cflag |= CSTOPB;
                break;
        default:
                return SP_ERR_ARG;
        }
+#endif
+       return SP_OK;
+}
 
-       term.c_iflag &= ~IGNPAR;
-       term.c_cflag &= ~(PARENB | PARODD);
-       switch (parity) {
-       case SP_PARITY_NONE:
-               term.c_iflag |= IGNPAR;
+static int set_rts(struct sp_port_data *data, int rts)
+{
+#ifdef _WIN32
+       switch (rts) {
+       case SP_RTS_OFF:
+               data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
                break;
-       case SP_PARITY_EVEN:
-               term.c_cflag |= PARENB;
+       case SP_RTS_ON:
+               data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
                break;
-       case SP_PARITY_ODD:
-               term.c_cflag |= PARENB | PARODD;
+       case SP_RTS_FLOW_CONTROL:
+               data->dcb.fRtsControl = RTS_CONTROL_HANDSHAKE;
                break;
        default:
                return SP_ERR_ARG;
        }
+#else
+       data->rts = rts;
+#endif
+       return SP_OK;
+}
 
-       /* Turn off all serial port cooking. */
-       term.c_iflag &= ~(ISTRIP | INLCR | ICRNL);
-       term.c_oflag &= ~(ONLCR | OCRNL | ONOCR);
-#if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
-       term.c_oflag &= ~OFILL;
+static int set_cts(struct sp_port_data *data, int cts)
+{
+#ifdef _WIN32
+       switch (cts) {
+       case SP_CTS_IGNORE:
+               data->dcb.fOutxCtsFlow = FALSE;
+               break;
+       case SP_CTS_FLOW_CONTROL:
+               data->dcb.fOutxCtsFlow = TRUE;
+               break;
+       default:
+               return SP_ERR_ARG;
+       }
+#else
+       data->cts = cts;
 #endif
+       return SP_OK;
+}
 
-       /* Disable canonical mode, and don't echo input characters. */
-       term.c_lflag &= ~(ICANON | ECHO);
+static int set_dtr(struct sp_port_data *data, int dtr)
+{
+#ifdef _WIN32
+       switch (dtr) {
+       case SP_DTR_OFF:
+               data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
+               break;
+       case SP_DTR_ON:
+               data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
+               break;
+       case SP_DTR_FLOW_CONTROL:
+               data->dcb.fDtrControl = DTR_CONTROL_HANDSHAKE;
+               break;
+       default:
+               return SP_ERR_ARG;
+       }
+#else
+       data->dtr = dtr;
+#endif
+       return SP_OK;
+}
 
-       /* Ignore modem status lines; enable receiver */
-       term.c_cflag |= (CLOCAL | CREAD);
+static int set_dsr(struct sp_port_data *data, int dsr)
+{
+#ifdef _WIN32
+       switch (dsr) {
+       case SP_DSR_IGNORE:
+               data->dcb.fOutxDsrFlow = FALSE;
+               break;
+       case SP_DSR_FLOW_CONTROL:
+               data->dcb.fOutxDsrFlow = TRUE;
+               break;
+       default:
+               return SP_ERR_ARG;
+       }
+#else
+       data->dsr = dsr;
+#endif
+       return SP_OK;
+}
 
-       /* Write the configured settings. */
-       if (tcsetattr(port->fd, TCSADRAIN, &term) < 0)
+static int set_xon_xoff(struct sp_port_data *data, int xon_xoff)
+{
+#ifdef _WIN32
+       switch (xon_xoff) {
+       case SP_XONXOFF_DISABLED:
+               data->dcb.fInX = FALSE;
+               data->dcb.fOutX = FALSE;
+               break;
+       case SP_XONXOFF_IN:
+               data->dcb.fInX = TRUE;
+               data->dcb.fOutX = FALSE;
+               break;
+       case SP_XONXOFF_OUT:
+               data->dcb.fInX = FALSE;
+               data->dcb.fOutX = TRUE;
+               break;
+       case SP_XONXOFF_INOUT:
+               data->dcb.fInX = TRUE;
+               data->dcb.fOutX = TRUE;
+               break;
+       default:
+               return SP_ERR_ARG;
+       }
+#else
+       data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
+       switch (xon_xoff) {
+       case SP_XONXOFF_DISABLED:
+               break;
+       case SP_XONXOFF_IN:
+               data->term.c_iflag |= IXOFF;
+               break;
+       case SP_XONXOFF_OUT:
+               data->term.c_iflag |= IXON | IXANY;
+               break;
+       case SP_XONXOFF_INOUT:
+               data->term.c_iflag |= IXON | IXOFF | IXANY;
+               break;
+       default:
+               return SP_ERR_ARG;
+       }
+#endif
+       return SP_OK;
+}
+
+static int apply_config(struct sp_port *port, struct sp_port_data *data)
+{
+#ifdef _WIN32
+       if (!SetCommState(port->hdl, &data->dcb))
                return SP_ERR_FAIL;
+#else
+       int controlbits;
 
-       if (rts != -1) {
+       /* Asymmetric use of RTS/CTS not supported yet. */
+       if ((data->rts == SP_RTS_FLOW_CONTROL) != (data->cts == SP_CTS_FLOW_CONTROL))
+               return SP_ERR_ARG;
+
+       /* DTR/DSR flow control not supported yet. */
+       if (data->dtr == SP_DTR_FLOW_CONTROL || data->dsr == SP_DSR_FLOW_CONTROL)
+               return SP_ERR_ARG;
+
+       if (data->rts == SP_RTS_FLOW_CONTROL)
+               data->term.c_iflag |= CRTSCTS;
+       else
+       {
                controlbits = TIOCM_RTS;
-               if (ioctl(port->fd, rts ? TIOCMBIS : TIOCMBIC,
+               if (ioctl(port->fd, data->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
                                &controlbits) < 0)
                        return SP_ERR_FAIL;
        }
 
-       if (dtr != -1) {
-               controlbits = TIOCM_DTR;
-               if (ioctl(port->fd, dtr ? TIOCMBIS : TIOCMBIC,
-                               &controlbits) < 0)
-                       return SP_ERR_FAIL;
-       }
+       controlbits = TIOCM_DTR;
+       if (ioctl(port->fd, data->dtr == SP_DTR_ON ? TIOCMBIS : TIOCMBIC,
+                       &controlbits) < 0)
+               return SP_ERR_FAIL;
+
+       /* Write the configured settings. */
+       if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0)
+               return SP_ERR_FAIL;
 #endif
+       return SP_OK;
+}
+
+#define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0)
+#define TRY_SET(x) do { if (config->x >= 0) TRY(set_##x(&data, config->x)); } while (0)
+
+int sp_set_config(struct sp_port *port, struct sp_port_config *config)
+{
+       struct sp_port_data data;
+
+       TRY(start_config(port, &data));
+       TRY_SET(baudrate);
+       TRY_SET(bits);
+       TRY_SET(parity);
+       TRY_SET(stopbits);
+       TRY_SET(rts);
+       TRY_SET(cts);
+       TRY_SET(dtr);
+       TRY_SET(dsr);
+       TRY_SET(xon_xoff);
+       TRY(apply_config(port, &data));
 
        return SP_OK;
 }
 
+#define CREATE_SETTER(x) int sp_set_##x(struct sp_port *port, int x) { \
+       struct sp_port_data data; \
+       TRY(start_config(port, &data)); \
+       TRY(set_##x(&data, x)); \
+       TRY(apply_config(port, &data)); \
+       return SP_OK; \
+}
+
+CREATE_SETTER(baudrate)
+CREATE_SETTER(bits)
+CREATE_SETTER(parity)
+CREATE_SETTER(stopbits)
+CREATE_SETTER(rts)
+CREATE_SETTER(cts)
+CREATE_SETTER(dtr)
+CREATE_SETTER(dsr)
+CREATE_SETTER(xon_xoff)
+
 int sp_last_error_code(void)
 {
 #ifdef _WIN32