]> sigrok.org Git - libserialport.git/blobdiff - serialport.c
New API for serial control lines.
[libserialport.git] / serialport.c
index 838f9c7bee2e76a79da2a8d91333002d92c9d427..58880d4c4cd868a2b729a44639ef2daf0fb49137 100644 (file)
@@ -51,9 +51,10 @@ struct sp_port_data {
        DCB dcb;
 #else
        struct termios term;
-       speed_t baud;
        int rts;
+       int cts;
        int dtr;
+       int dsr;
 #endif
 };
 
@@ -116,6 +117,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;
@@ -124,6 +126,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;
@@ -135,7 +138,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;
 
@@ -343,6 +346,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);
@@ -395,6 +399,7 @@ int sp_open(struct sp_port *port, int flags)
                return SP_ERR_FAIL;
 #else
        int flags_local = 0;
+
        /* Map 'flags' to the OS-specific settings. */
        if (flags & SP_MODE_RDWR)
                flags_local |= O_RDWR;
@@ -452,6 +457,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;
@@ -459,10 +465,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
 }
 
@@ -475,12 +482,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;
@@ -555,69 +564,77 @@ static int set_baudrate(struct sp_port_data *data, int baudrate)
                return SP_ERR_ARG;
        }
 #else
+       speed_t baud;
        switch (baudrate) {
        case 50:
-               data->baud = B50;
+               baud = B50;
                break;
        case 75:
-               data->baud = B75;
+               baud = B75;
                break;
        case 110:
-               data->baud = B110;
+               baud = B110;
                break;
        case 134:
-               data->baud = B134;
+               baud = B134;
                break;
        case 150:
-               data->baud = B150;
+               baud = B150;
                break;
        case 200:
-               data->baud = B200;
+               baud = B200;
                break;
        case 300:
-               data->baud = B300;
+               baud = B300;
                break;
        case 600:
-               data->baud = B600;
+               baud = B600;
                break;
        case 1200:
-               data->baud = B1200;
+               baud = B1200;
                break;
        case 1800:
-               data->baud = B1800;
+               baud = B1800;
                break;
        case 2400:
-               data->baud = B2400;
+               baud = B2400;
                break;
        case 4800:
-               data->baud = B4800;
+               baud = B4800;
                break;
        case 9600:
-               data->baud = B9600;
+               baud = B9600;
                break;
        case 19200:
-               data->baud = B19200;
+               baud = B19200;
                break;
        case 38400:
-               data->baud = B38400;
+               baud = B38400;
                break;
        case 57600:
-               data->baud = B57600;
+               baud = B57600;
                break;
        case 115200:
-               data->baud = B115200;
+               baud = B115200;
                break;
        case 230400:
-               data->baud = B230400;
+               baud = B230400;
                break;
 #if !defined(__APPLE__) && !defined(__OpenBSD__)
        case 460800:
-               data->baud = B460800;
+               baud = B460800;
                break;
 #endif
        default:
                return SP_ERR_ARG;
        }
+
+       if (cfsetospeed(&data->term, baud) < 0)
+               return SP_ERR_FAIL;
+
+       if (cfsetispeed(&data->term, baud) < 0)
+               return SP_ERR_FAIL;
+
 #endif
        return SP_OK;
 }
@@ -712,39 +729,43 @@ static int set_stopbits(struct sp_port_data *data, int stopbits)
        return SP_OK;
 }
 
-static int set_flowcontrol(struct sp_port_data *data, int flowcontrol)
+static int set_rts(struct sp_port_data *data, int rts)
 {
-#ifndef _WIN32
-       data->term.c_iflag &= ~(IXON | IXOFF | IXANY);
-       data->term.c_cflag &= ~CRTSCTS;
-       switch (flowcontrol) {
-       case 0:
-               /* No flow control. */
+#ifdef _WIN32
+       switch (rts) {
+       case SP_RTS_OFF:
+               data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
                break;
-       case 1:
-               data->term.c_cflag |= CRTSCTS;
+       case SP_RTS_ON:
+               data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
                break;
-       case 2:
-               data->term.c_iflag |= IXON | IXOFF | IXANY;
+       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;
 }
 
-static int set_rts(struct sp_port_data *data, int rts)
+static int set_cts(struct sp_port_data *data, int cts)
 {
 #ifdef _WIN32
-       if (rts != -1) {
-               if (rts)
-                       data->dcb.fRtsControl = RTS_CONTROL_ENABLE;
-               else
-                       data->dcb.fRtsControl = RTS_CONTROL_DISABLE;
+       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->rts = rts;
+       data->cts = cts;
 #endif
        return SP_OK;
 }
@@ -752,11 +773,18 @@ static int set_rts(struct sp_port_data *data, int rts)
 static int set_dtr(struct sp_port_data *data, int dtr)
 {
 #ifdef _WIN32
-       if (dtr != -1) {
-               if (dtr)
-                       data->dcb.fDtrControl = DTR_CONTROL_ENABLE;
-               else
-                       data->dcb.fDtrControl = DTR_CONTROL_DISABLE;
+       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;
@@ -764,6 +792,69 @@ static int set_dtr(struct sp_port_data *data, int dtr)
        return SP_OK;
 }
 
+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;
+}
+
+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
@@ -784,48 +875,53 @@ static int apply_config(struct sp_port *port, struct sp_port_data *data)
        /* Ignore modem status lines; enable receiver */
        data->term.c_cflag |= (CLOCAL | CREAD);
 
-       /* Write the configured settings. */
-       if (tcsetattr(port->fd, TCSADRAIN, &data->term) < 0)
-               return SP_ERR_FAIL;
-
-       if (cfsetospeed(&data->term, data->baud) < 0)
-               return SP_ERR_FAIL;
+       /* 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;
 
-       if (cfsetispeed(&data->term, data->baud) < 0)
-               return SP_ERR_FAIL;
+       /* 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 != -1) {
+       if (data->rts == SP_RTS_FLOW_CONTROL)
+               data->term.c_iflag |= CRTSCTS;
+       else
+       {
                controlbits = TIOCM_RTS;
-               if (ioctl(port->fd, data->rts ? TIOCMBIS : TIOCMBIC,
+               if (ioctl(port->fd, data->rts == SP_RTS_ON ? TIOCMBIS : TIOCMBIC,
                                &controlbits) < 0)
                        return SP_ERR_FAIL;
        }
 
-       if (data->dtr != -1) {
-               controlbits = TIOCM_DTR;
-               if (ioctl(port->fd, data->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_params(struct sp_port *port, int baudrate, int bits, int parity,
-               int stopbits, int flowcontrol, int rts, int dtr)
+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(&data, baudrate));
-       TRY(set_bits(&data, bits));
-       TRY(set_parity(&data, parity));
-       TRY(set_stopbits(&data, stopbits));
-       TRY(set_flowcontrol(&data, flowcontrol));
-       TRY(set_rts(&data, rts));
-       TRY(set_dtr(&data, dtr));
+       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;