serial: Added flag IXANY (any char will restart) to XON/XOFF handshaking.

[libsigrok.git] / hardware / common / serial.c

diff --git a/hardware/common/serial.c b/hardware/common/serial.c
index 336e78ce288b52f2cb07b5b9a7f5bb5da72297b4..0c64203fc8bf7f833645a8ff49cbf79422dab834 100644 (file)
--- a/hardware/common/serial.c
+++ b/hardware/common/serial.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
@@ -27,7 +27,6 @@
 #ifdef _WIN32
 #include <windows.h>
 #else
-#include <glob.h>
 #include <termios.h>
 #include <sys/ioctl.h>
 #endif
@@ -37,14 +36,14 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "serial: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+/* Message logging helpers with subsystem-specific prefix string. */
+#define LOG_PREFIX "serial: "
+#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
+#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
+#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
+#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
+#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
 
 // FIXME: Must be moved, or rather passed as function argument.
 #ifdef _WIN32
@@ -278,8 +277,6 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 #else
        /* Returns the number of bytes read, or -1 upon failure. */
        ret = read(serial->fd, buf, count);
-       if (ret >= 0)
-               sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
 #endif
 
        return ret;
@@ -424,7 +421,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 
        if (dtr != -1) {
                sr_spew("Setting DTR %s.", dtr ? "high" : "low");
-               if (rts)
+               if (dtr)
                        dcb.fDtrControl = DTR_CONTROL_ENABLE;
                else
                        dcb.fDtrControl = DTR_CONTROL_DISABLE;
@@ -501,7 +498,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
        case 230400:
                baud = B230400;
                break;
-#ifndef __APPLE__
+#if !defined(__APPLE__) && !defined(__OpenBSD__)
        case 460800:
                baud = B460800;
                break;
@@ -551,7 +548,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
                return SR_ERR;
        }
 
-       term.c_iflag &= ~(IXON | IXOFF);
+       term.c_iflag &= ~(IXON | IXOFF | IXANY);
        term.c_cflag &= ~CRTSCTS;
        switch (flowcontrol) {
        case 0:
@@ -564,7 +561,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
                break;
        case 2:
                sr_spew("Configuring XON/XOFF flow control.");
-               term.c_iflag |= IXON | IXOFF;
+               term.c_iflag |= (IXON | IXOFF | IXANY);
                break;
        default:
                sr_err("Unsupported flow control setting %d.", flowcontrol);
@@ -572,7 +569,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
        }
 
        term.c_iflag &= ~IGNPAR;
-       term.c_cflag &= ~(PARODD | PARENB);
+       term.c_cflag &= ~(PARENB | PARODD);
        switch (parity) {
        case SERIAL_PARITY_NONE:
                sr_spew("Configuring no parity.");
@@ -591,8 +588,12 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
                return SR_ERR;
        }
 
-       /* Do not translate carriage return to newline on input. */
-       term.c_iflag &= ~(ICRNL);
+       /* 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;
+#endif
 
        /* Disable canonical mode, and don't echo input characters. */
        term.c_lflag &= ~(ICANON | ECHO);
@@ -633,8 +634,8 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
  *
  * @param serial Previously initialized serial port structure.
  * @param paramstr A serial communication parameters string, in the form
- * of <speed>/<data bits><parity><stopbits>, for example "9600/8n1" or
- * "600/7o2".
+ * of <speed>/<data bits><parity><stopbits><flow>, for example "9600/8n1" or
+ * "600/7o2" or "460800/8n1/flow=2" where flow is 0 for none, 1 for rts/cts and 2 for xon/xoff.
  *
  * @return SR_OK upon success, SR_ERR upon failure.
  */
@@ -644,10 +645,10 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 {
        GRegex *reg;
        GMatchInfo *match;
-       int speed, databits, parity, stopbits, rts, dtr, i;
+       int speed, databits, parity, stopbits, flow, rts, dtr, i;
        char *mstr, **opts, **kv;
 
-       speed = databits = parity = stopbits = 0;
+       speed = databits = parity = stopbits = flow = 0;
        rts = dtr = -1;
        sr_spew("Parsing parameters from \"%s\".", paramstr);
        reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
@@ -702,6 +703,17 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
                                                        sr_dbg("invalid value for dtr: %c", kv[1][0]);
                                                        speed = 0;
                                                }
+                                       } else if (!strncmp(kv[0], "flow", 4)) {
+                                               if (kv[1][0] == '0')
+                                                       flow = 0;
+                                               else if (kv[1][0] == '1')
+                                                       flow = 1;
+                                               else if (kv[1][0] == '2')
+                                                       flow = 2;
+                                               else {
+                                                       sr_dbg("invalid value for flow: %c", kv[1][0]);
+                                                       speed = 0;
+                                               }
                                        }
                                        g_strfreev(kv);
                                }
@@ -715,7 +727,7 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 
        if (speed) {
                return serial_set_params(serial, speed, databits, parity,
-                                        stopbits, 0, rts, dtr);
+                                        stopbits, flow, rts, dtr);
        } else {
                sr_dbg("Could not infer speed from parameter string.");
                return SR_ERR_ARG;
@@ -774,7 +786,8 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
                if (g_get_monotonic_time() - start > timeout_ms)
                        /* Timeout */
                        break;
-               g_usleep(2000);
+               if (len < 1)
+                       g_usleep(2000);
        }
        if (*buflen)
                sr_dbg("Received %d: '%s'.", *buflen, *buf);
@@ -855,7 +868,8 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
                        sr_dbg("Detection timed out after %dms.", time);
                        break;
                }
-               g_usleep(byte_delay_us);
+               if (len < 1)
+                       g_usleep(byte_delay_us);
        }
 
        *buflen = ibuf;