]> sigrok.org Git - libsigrok.git/blobdiff - hardware/common/serial.c
Route sr_source_remove for all serial devices through a wrapper.
[libsigrok.git] / hardware / common / serial.c
index 3bb073870702da6853de02996132cade7d501182..af80356a3cc72a714627a272e0a420c1a22e28d0 100644 (file)
@@ -1,8 +1,9 @@
 /*
- * 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>
+ * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  */
 
 #include <string.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <unistd.h>
-#ifdef _WIN32
-#include <windows.h>
-#else
-#include <glob.h>
-#include <termios.h>
-#endif
 #include <stdlib.h>
-#include <errno.h>
 #include <glib.h>
+#include <libserialport.h>
 #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)
-
-// FIXME: Must be moved, or rather passed as function argument.
-#ifdef _WIN32
-static HANDLE hdl;
-#endif
+/* 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)
 
 /**
  * Open the specified serial port.
  *
  * @param serial Previously initialized serial port structure.
- * @param flags Flags to use when opening the serial port.
- * TODO: Abstract 'flags', currently they're OS-specific!
+ * @param flags Flags to use when opening the serial port. Possible flags
+ *              include SERIAL_RDWR, SERIAL_RDONLY, SERIAL_NONBLOCK.
  *
  * If the serial structure contains a serialcomm string, it will be
  * passed to serial_set_paramstr() after the port is opened.
@@ -63,6 +49,9 @@ static HANDLE hdl;
  */
 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 {
+       int ret;
+       char *error;
+       int sp_flags = 0;
 
        if (!serial) {
                sr_dbg("Invalid serial port.");
@@ -71,20 +60,30 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 
        sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
 
-#ifdef _WIN32
-       hdl = CreateFile(serial->port, GENERIC_READ | GENERIC_WRITE, 0, 0,
-                        OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
-       if (hdl == INVALID_HANDLE_VALUE) {
-               sr_err("Error opening serial port '%s'.", serial->port);
+       sp_get_port_by_name(serial->port, &serial->data);
+
+       if (flags & SERIAL_RDWR)
+               sp_flags = (SP_MODE_READ | SP_MODE_WRITE);
+       else if (flags & SERIAL_RDONLY)
+               sp_flags = SP_MODE_READ;
+
+       serial->nonblocking = (flags & SERIAL_NONBLOCK) ? 1 : 0;
+
+       ret = sp_open(serial->data, sp_flags);
+
+       switch (ret) {
+       case SP_ERR_ARG:
+               sr_err("Attempt to open serial port with invalid parameters.");
+               return SR_ERR_ARG;
+       case SP_ERR_FAIL:
+               error = sp_last_error_message();
+               sr_err("Error opening port: %s.", error);
+               sp_free_error_message(error);
                return SR_ERR;
        }
-#else
-       if ((serial->fd = open(serial->port, flags)) < 0) {
-               sr_err("Error opening serial port '%s': %s.", serial->port,
-                      strerror(errno));
-               return SR_ERR;
-       } else
-               sr_spew("Opened serial port '%s' (fd %d).", serial->port, serial->fd);
+
+#ifndef _WIN32
+       sp_get_port_handle(serial->data, &serial->fd);
 #endif
 
        if (serial->serialcomm)
@@ -103,6 +102,7 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 {
        int ret;
+       char *error;
 
        if (!serial) {
                sr_dbg("Invalid serial port.");
@@ -116,24 +116,24 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
        }
 
        sr_spew("Closing serial port %s (fd %d).", serial->port, serial->fd);
-       ret = SR_OK;
-
-#ifdef _WIN32
-       /* Returns non-zero upon success, 0 upon failure. */
-       if (CloseHandle(hdl) == 0)
-               ret = SR_ERR;
-#else
-       /* Returns 0 upon success, -1 upon failure. */
-       if (close(serial->fd) < 0) {
-               sr_err("Error closing serial port: %s (fd %d).", strerror(errno),
-                               serial->fd);
-               ret = SR_ERR;
+
+       ret = sp_close(serial->data);
+       sp_free_port(serial->data);
+
+       switch (ret) {
+       case SP_ERR_ARG:
+               sr_err("Attempt to close an invalid serial port.");
+               return SR_ERR_ARG;
+       case SP_ERR_FAIL:
+               error = sp_last_error_message();
+               sr_err("Error closing port: %s.", error);
+               sp_free_error_message(error);
+               return SR_ERR;
        }
-#endif
 
        serial->fd = -1;
 
-       return ret;
+       return SR_OK;
 }
 
 /**
@@ -146,6 +146,7 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 {
        int ret;
+       char *error;
 
        if (!serial) {
                sr_dbg("Invalid serial port.");
@@ -159,23 +160,21 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
        }
 
        sr_spew("Flushing serial port %s (fd %d).", serial->port, serial->fd);
-       ret = SR_OK;
 
-#ifdef _WIN32
-       /* Returns non-zero upon success, 0 upon failure. */
-       if (PurgeComm(hdl, PURGE_RXCLEAR | PURGE_TXCLEAR) == 0) ) {
-               sr_err("Error flushing serial port: %s.", strerror(errno));
-               ret = SR_ERR;
-       }
-#else
-       /* Returns 0 upon success, -1 upon failure. */
-       if (tcflush(serial->fd, TCIOFLUSH) < 0) {
-               sr_err("Error flushing serial port: %s.", strerror(errno));
-               ret = SR_ERR;
+       ret = sp_flush(serial->data, SP_BUF_BOTH);
+
+       switch (ret) {
+       case SP_ERR_ARG:
+               sr_err("Attempt to flush an invalid serial port.");
+               return SR_ERR_ARG;
+       case SP_ERR_FAIL:
+               error = sp_last_error_message();
+               sr_err("Error flushing port: %s.", error);
+               sp_free_error_message(error);
+               return SR_ERR;
        }
 
-       return ret;
-#endif
+       return SR_OK;
 }
 
 /**
@@ -185,38 +184,42 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
  * @param buf Buffer containing the bytes to write.
  * @param count Number of bytes to write.
  *
- * @return The number of bytes written, or -1 upon failure.
+ * @return The number of bytes written, or a negative error code upon failure.
  */
 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
                const void *buf, size_t count)
 {
        ssize_t ret;
+       char *error;
 
        if (!serial) {
                sr_dbg("Invalid serial port.");
-               return -1;
+               return SR_ERR;
        }
 
        if (serial->fd == -1) {
                sr_dbg("Cannot use unopened serial port %s (fd %d).",
                                serial->port, serial->fd);
-               return -1;
+               return SR_ERR;
        }
 
-#ifdef _WIN32
-       DWORD tmp = 0;
-
-       /* FIXME */
-       /* Returns non-zero upon success, 0 upon failure. */
-       WriteFile(hdl, buf, count, &tmp, NULL);
-#else
-       /* Returns the number of bytes written, or -1 upon failure. */
-       ret = write(serial->fd, buf, count);
-       if (ret < 0)
-               sr_err("Write error: %s.", strerror(errno));
+       if (serial->nonblocking)
+               ret = sp_nonblocking_write(serial->data, buf, count);
        else
-               sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd);
-#endif
+               ret = sp_blocking_write(serial->data, buf, count, 0);
+
+       switch (ret) {
+       case SP_ERR_ARG:
+               sr_err("Attempted serial port write with invalid arguments.");
+               return SR_ERR_ARG;
+       case SP_ERR_FAIL:
+               error = sp_last_error_message();
+               sr_err("Write error: %s.", error);
+               sp_free_error_message(error);
+               return SR_ERR;
+       }
+
+       sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd);
 
        return ret;
 }
@@ -228,42 +231,43 @@ SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
  * @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, or -1 upon failure.
+ * @return The number of bytes read, or a negative error code upon failure.
  */
 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
                size_t count)
 {
        ssize_t ret;
+       char *error;
 
        if (!serial) {
                sr_dbg("Invalid serial port.");
-               return -1;
+               return SR_ERR;
        }
 
        if (serial->fd == -1) {
                sr_dbg("Cannot use unopened serial port %s (fd %d).",
                                serial->port, serial->fd);
-               return -1;
+               return SR_ERR;
        }
 
-#ifdef _WIN32
-       DWORD tmp = 0;
-
-       /* FIXME */
-       /* Returns non-zero upon success, 0 upon failure. */
-       return ReadFile(hdl, buf, count, &tmp, NULL);
-#else
-       /* Returns the number of bytes read, or -1 upon failure. */
-       ret = read(serial->fd, buf, count);
-       if (ret < 0)
-               /*
-                * Should be sr_err(), but that would yield lots of
-                * "Resource temporarily unavailable" messages.
-                */
-               sr_spew("Read error: %s (fd %d).", strerror(errno), serial->fd);
+       if (serial->nonblocking)
+               ret = sp_nonblocking_read(serial->data, buf, count);
        else
+               ret = sp_blocking_read(serial->data, buf, count, 0);
+
+       switch (ret) {
+       case SP_ERR_ARG:
+               sr_err("Attempted serial port read with invalid arguments.");
+               return SR_ERR_ARG;
+       case SP_ERR_FAIL:
+               error = sp_last_error_message();
+               sr_err("Read error: %s.", error);
+               sp_free_error_message(error);
+               return SR_ERR;
+       }
+
+       if (ret > 0)
                sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
-#endif
 
        return ret;
 }
@@ -282,8 +286,12 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
  * @return SR_OK upon success, SR_ERR upon failure.
  */
 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
-               int bits, int parity, int stopbits, int flowcontrol)
+                             int bits, int parity, int stopbits,
+                             int flowcontrol, int rts, int dtr)
 {
+       int ret;
+       char *error;
+       struct sp_port_config *config;
 
        if (!serial) {
                sr_dbg("Invalid serial port.");
@@ -292,218 +300,49 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 
        if (serial->fd == -1) {
                sr_dbg("Cannot configure unopened serial port %s (fd %d).",
-                               serial->port, serial->fd);
+                      serial->port, serial->fd);
                return SR_ERR;
        }
 
        sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
-                       serial->fd);
-
-#ifdef _WIN32
-       DCB dcb;
+               serial->fd);
 
-       if (!GetCommState(hdl, &dcb))
-               return SR_ERR;
-
-       switch (baudrate) {
-       case 115200:
-               dcb.BaudRate = CBR_115200;
-               break;
-       case 57600:
-               dcb.BaudRate = CBR_57600;
-               break;
-       case 38400:
-               dcb.BaudRate = CBR_38400;
-               break;
-       case 19200:
-               dcb.BaudRate = CBR_19200;
-               break;
-       case 9600:
-               dcb.BaudRate = CBR_9600;
-               break;
-       case 4800:
-               dcb.BaudRate = CBR_4800;
-               break;
-       case 2400:
-               dcb.BaudRate = CBR_2400;
-               break;
-       default:
-               sr_err("Unsupported baudrate %d.", baudrate);
-               return SR_ERR;
-       }
-       dcb.ByteSize = bits;
-       dcb.Parity = NOPARITY; /* TODO: Don't hardcode. */
-       dcb.StopBits = ONESTOPBIT; /* TODO: Don't hardcode. */
-
-       if (!SetCommState(hdl, &dcb))
-               return SR_ERR;
-#else
-       struct termios term;
-       speed_t baud;
-
-       if (tcgetattr(serial->fd, &term) < 0) {
-               sr_err("tcgetattr() error on port %s (fd %d): %s.",
-                               serial->port, serial->fd, strerror(errno));
-               return SR_ERR;
-       }
-
-       switch (baudrate) {
-       case 50:
-               baud = B50;
-               break;
-       case 75:
-               baud = B75;
-               break;
-       case 110:
-               baud = B110;
-               break;
-       case 134:
-               baud = B134;
-               break;
-       case 150:
-               baud = B150;
-               break;
-       case 200:
-               baud = B200;
-               break;
-       case 300:
-               baud = B300;
-               break;
-       case 600:
-               baud = B600;
-               break;
-       case 1200:
-               baud = B1200;
-               break;
-       case 1800:
-               baud = B1800;
-               break;
-       case 2400:
-               baud = B2400;
-               break;
-       case 4800:
-               baud = B4800;
-               break;
-       case 9600:
-               baud = B9600;
-               break;
-       case 19200:
-               baud = B19200;
-               break;
-       case 38400:
-               baud = B38400;
-               break;
-       case 57600:
-               baud = B57600;
-               break;
-       case 115200:
-               baud = B115200;
-               break;
-       case 230400:
-               baud = B230400;
-               break;
-#ifndef __APPLE__
-       case 460800:
-               baud = B460800;
-               break;
-#endif
-       default:
-               sr_err("Unsupported baudrate %d.", baudrate);
-               return SR_ERR;
-       }
-
-       sr_spew("Configuring output baudrate to %d (%d).", baudrate, baud);
-       if (cfsetospeed(&term, baud) < 0) {
-               sr_err("cfsetospeed() error: %s.", strerror(errno));
-               return SR_ERR;
-       }
-
-       sr_spew("Configuring input baudrate to %d (%d).", baudrate, baud);
-       if (cfsetispeed(&term, baud) < 0) {
-               sr_err("cfsetispeed() error: %s.", strerror(errno));
-               return SR_ERR;
-       }
-
-       sr_spew("Configuring %d data bits.", bits);
-       term.c_cflag &= ~CSIZE;
-       switch (bits) {
-       case 8:
-               term.c_cflag |= CS8;
-               break;
-       case 7:
-               term.c_cflag |= CS7;
-               break;
-       default:
-               sr_err("Unsupported data bits number %d.", bits);
-               return SR_ERR;
-       }
-
-       sr_spew("Configuring %d stop bits.", stopbits);
-       term.c_cflag &= ~CSTOPB;
-       switch (stopbits) {
-       case 1:
-               term.c_cflag &= ~CSTOPB;
-               break;
-       case 2:
-               term.c_cflag |= CSTOPB;
-               break;
-       default:
-               sr_err("Unsupported stopbits number %d.", stopbits);
-               return SR_ERR;
-       }
-
-       term.c_iflag &= ~(IXON | IXOFF);
-       term.c_cflag &= ~CRTSCTS;
-       switch (flowcontrol) {
+       sp_new_config(&config);
+       sp_set_config_baudrate(config, baudrate);
+       sp_set_config_bits(config, bits);
+       switch (parity) {
        case 0:
-               /* No flow control. */
-               sr_spew("Configuring no flow control.");
+               sp_set_config_parity(config, SP_PARITY_NONE);
                break;
        case 1:
-               sr_spew("Configuring RTS/CTS flow control.");
-               term.c_cflag |= CRTSCTS;
+               sp_set_config_parity(config, SP_PARITY_EVEN);
                break;
        case 2:
-               sr_spew("Configuring XON/XOFF flow control.");
-               term.c_iflag |= IXON | IXOFF;
-               break;
-       default:
-               sr_err("Unsupported flow control setting %d.", flowcontrol);
-               return SR_ERR;
-       }
-
-       term.c_iflag &= ~IGNPAR;
-       term.c_cflag &= ~(PARODD | PARENB);
-       switch (parity) {
-       case SERIAL_PARITY_NONE:
-               sr_spew("Configuring no parity.");
-               term.c_iflag |= IGNPAR;
-               break;
-       case SERIAL_PARITY_EVEN:
-               sr_spew("Configuring even parity.");
-               term.c_cflag |= PARENB;
-               break;
-       case SERIAL_PARITY_ODD:
-               sr_spew("Configuring odd parity.");
-               term.c_cflag |= PARENB | PARODD;
+               sp_set_config_parity(config, SP_PARITY_ODD);
                break;
        default:
-               sr_err("Unsupported parity setting %d.", parity);
-               return SR_ERR;
+               return SR_ERR_ARG;
        }
-
-       /* Do not translate carriage return to newline on input. */
-       term.c_iflag &= ~(ICRNL);
-
-       /* Disable canonical mode, and don't echo input characters. */
-       term.c_lflag &= ~(ICANON | ECHO);
-
-       /* Write the configured settings. */
-       if (tcsetattr(serial->fd, TCSADRAIN, &term) < 0) {
-               sr_err("tcsetattr() error: %s.", strerror(errno));
+       sp_set_config_stopbits(config, stopbits);
+       sp_set_config_rts(config, flowcontrol == 1 ? SP_RTS_FLOW_CONTROL : rts);
+       sp_set_config_cts(config, flowcontrol == 1 ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE);
+       sp_set_config_dtr(config, dtr);
+       sp_set_config_dsr(config, SP_DSR_IGNORE);
+       sp_set_config_xon_xoff(config, flowcontrol == 2 ? SP_XONXOFF_INOUT : SP_XONXOFF_DISABLED);
+
+       ret = sp_set_config(serial->data, config);
+       sp_free_config(config);
+
+       switch (ret) {
+       case SP_ERR_ARG:
+               sr_err("Invalid arguments for setting serial port parameters.");
+               return SR_ERR_ARG;
+       case SP_ERR_FAIL:
+               error = sp_last_error_message();
+               sr_err("Error setting serial port parameters: %s.", error);
+               sp_free_error_message(error);
                return SR_ERR;
        }
-#endif
 
        return SR_OK;
 }
@@ -513,21 +352,23 @@ 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.
  */
-#define SERIAL_COMM_SPEC "^(\\d+)/([78])([neo])([12])$"
+#define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
                const char *paramstr)
 {
        GRegex *reg;
        GMatchInfo *match;
-       int speed, databits, parity, stopbits;
-       char *mstr;
+       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);
        if (g_regex_match(reg, paramstr, 0, &match)) {
                if ((mstr = g_match_info_fetch(match, 1)))
@@ -553,14 +394,62 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
                if ((mstr = g_match_info_fetch(match, 4)))
                        stopbits = strtoul(mstr, NULL, 10);
                g_free(mstr);
+               if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
+                       if (mstr[0] != '/') {
+                               sr_dbg("missing separator before extra options");
+                               speed = 0;
+                       } else {
+                               /* A set of "key=value" options separated by / */
+                               opts = g_strsplit(mstr + 1, "/", 0);
+                               for (i = 0; opts[i]; i++) {
+                                       kv = g_strsplit(opts[i], "=", 2);
+                                       if (!strncmp(kv[0], "rts", 3)) {
+                                               if (kv[1][0] == '1')
+                                                       rts = 1;
+                                               else if (kv[1][0] == '0')
+                                                       rts = 0;
+                                               else {
+                                                       sr_dbg("invalid value for rts: %c", kv[1][0]);
+                                                       speed = 0;
+                                               }
+                                       } else if (!strncmp(kv[0], "dtr", 3)) {
+                                               if (kv[1][0] == '1')
+                                                       dtr = 1;
+                                               else if (kv[1][0] == '0')
+                                                       dtr = 0;
+                                               else {
+                                                       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);
+                               }
+                               g_strfreev(opts);
+                       }
+               }
+               g_free(mstr);
        }
        g_match_info_unref(match);
        g_regex_unref(reg);
 
-       if (speed)
-               return serial_set_params(serial, speed, databits, parity, stopbits, 0);
-       else
+       if (speed) {
+               return serial_set_params(serial, speed, databits, parity,
+                                        stopbits, flow, rts, dtr);
+       } else {
+               sr_dbg("Could not infer speed from parameter string.");
                return SR_ERR_ARG;
+       }
 }
 
 /**
@@ -615,10 +504,148 @@ 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);
 
        return SR_OK;
 }
+
+/**
+ * Try to find a valid packet in a serial data stream.
+ *
+ * @param serial Previously initialized serial port structure.
+ * @param buf Buffer containing the bytes to write.
+ * @param count Size of the buffer.
+ * @param packet_size Size, in bytes, of a valid packet.
+ * @param is_valid Callback that assesses whether the packet is valid or not.
+ * @param timeout_ms The timeout after which, if no packet is detected, to
+ *                   abort scanning.
+ * @param baudrate The baudrate of the serial port. This parameter is not
+ *                 critical, but it helps fine tune the serial port polling
+ *                 delay.
+ *
+ * @return SR_OK if a valid packet is found within the given timeout,
+ *         SR_ERR upon failure.
+ */
+SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
+                                uint8_t *buf, size_t *buflen,
+                                size_t packet_size, packet_valid_t is_valid,
+                                uint64_t timeout_ms, int baudrate)
+{
+       uint64_t start, time, byte_delay_us;
+       size_t ibuf, i, maxlen;
+       int len;
+
+       maxlen = *buflen;
+
+       sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64
+              "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate);
+
+       if (maxlen < (packet_size / 2) ) {
+               sr_err("Buffer size must be at least twice the packet size.");
+               return SR_ERR;
+       }
+
+       /* Assume 8n1 transmission. That is 10 bits for every byte. */
+       byte_delay_us = 10 * (1000000 / baudrate);
+       start = g_get_monotonic_time();
+
+       i = ibuf = len = 0;
+       while (ibuf < maxlen) {
+               len = serial_read(serial, &buf[ibuf], 1);
+               if (len > 0) {
+                       ibuf += len;
+               } else if (len == 0) {
+                       /* No logging, already done in serial_read(). */
+               } else {
+                       /* Error reading byte, but continuing anyway. */
+               }
+
+               time = g_get_monotonic_time() - start;
+               time /= 1000;
+
+               if ((ibuf - i) >= packet_size) {
+                       /* We have at least a packet's worth of data. */
+                       if (is_valid(&buf[i])) {
+                               sr_spew("Found valid %d-byte packet after "
+                                       "%" PRIu64 "ms.", (ibuf - i), time);
+                               *buflen = ibuf;
+                               return SR_OK;
+                       } else {
+                               sr_spew("Got %d bytes, but not a valid "
+                                       "packet.", (ibuf - i));
+                       }
+                       /* Not a valid packet. Continue searching. */
+                       i++;
+               }
+               if (time >= timeout_ms) {
+                       /* Timeout */
+                       sr_dbg("Detection timed out after %dms.", time);
+                       break;
+               }
+               if (len < 1)
+                       g_usleep(byte_delay_us);
+       }
+
+       *buflen = ibuf;
+
+       sr_err("Didn't find a valid packet (read %d bytes).", *buflen);
+
+       return SR_ERR;
+}
+
+/**
+ * Extract the serial device and options from the options linked list.
+ *
+ * @param options List of options passed from the command line.
+ * @param serial_device Pointer where to store the exctracted serial device.
+ * @param serial_options Pointer where to store the optional extracted serial
+ * options.
+ *
+ * @return SR_OK if a serial_device is found, SR_ERR if no device is found. The
+ * returned string should not be freed by the caller.
+ */
+SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
+                                     const char **serial_options)
+{
+       GSList *l;
+       struct sr_config *src;
+
+       *serial_device = NULL;
+
+       for (l = options; l; l = l->next) {
+               src = l->data;
+               switch (src->key) {
+               case SR_CONF_CONN:
+                       *serial_device = g_variant_get_string(src->data, NULL);
+                       sr_dbg("Parsed serial device: %s", *serial_device);
+                       break;
+
+               case SR_CONF_SERIALCOMM:
+                       *serial_options = g_variant_get_string(src->data, NULL);
+                       sr_dbg("Parsed serial options: %s", *serial_options);
+                       break;
+               }
+       }
+
+       if (!*serial_device) {
+               sr_dbg("No serial device specified");
+               return SR_ERR;
+       }
+
+       return SR_OK;
+}
+
+SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
+               int timeout, sr_receive_data_callback_t cb, void *cb_data)
+{
+       return sr_source_add(serial->fd, events, timeout, cb, cb_data);
+}
+
+SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial)
+{
+       return sr_source_remove(serial->fd);
+}