]> sigrok.org Git - libsigrok.git/blobdiff - src/serial.c
scpi-pps: Support for the EEZ PSU series
[libsigrok.git] / src / serial.c
index 3b1f4264ce714eee277d2bcabf7f17fe401e7585..97bd3159b094f673e0db8070d87eadb960e1cab8 100644 (file)
@@ -5,6 +5,7 @@
  * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
  * Copyright (C) 2014 Uffe Jakobsen <uffe@uffe.org>
+ * Copyright (C) 2017-2019 Gerhard Sittig <gerhard.sittig@gmx.net>
  *
  * 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
@@ -25,7 +26,9 @@
 #include <stdlib.h>
 #include <glib.h>
 #include <glib/gstdio.h>
+#ifdef HAVE_LIBSERIALPORT
 #include <libserialport.h>
+#endif
 #include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 #ifdef _WIN32
  * @{
  */
 
+#ifdef HAVE_SERIAL_COMM
+
+/* See if an (assumed opened) serial port is of any supported type. */
+static int dev_is_supported(struct sr_serial_dev_inst *serial)
+{
+       if (!serial || !serial->lib_funcs)
+               return 0;
+
+       return 1;
+}
+
 /**
  * Open the specified serial port.
  *
@@ -76,14 +90,56 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 
        sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
 
-       ret = sr_ser_libsp_open(serial, flags);
+       /*
+        * Determine which serial transport library to use. Derive the
+        * variant from the serial port's name. Default to libserialport
+        * for backwards compatibility.
+        */
+       if (ser_name_is_hid(serial))
+               serial->lib_funcs = ser_lib_funcs_hid;
+       else if (ser_name_is_bt(serial))
+               serial->lib_funcs = ser_lib_funcs_bt;
+       else
+               serial->lib_funcs = ser_lib_funcs_libsp;
+       if (!serial->lib_funcs)
+               return SR_ERR_NA;
+
+       /*
+        * Note that use of the 'rcv_buffer' is optional, and the buffer's
+        * size heavily depends on the specific transport. That's why the
+        * buffer's content gets accessed and the buffer is released here in
+        * common code, but the buffer gets allocated in libraries' open()
+        * routines.
+        */
+
+       /*
+        * Run the transport's open routine. Setup the bitrate and the
+        * UART frame format.
+        */
+       if (!serial->lib_funcs->open)
+               return SR_ERR_NA;
+       ret = serial->lib_funcs->open(serial, flags);
        if (ret != SR_OK)
                return ret;
 
-       if (serial->serialcomm)
-               return serial_set_paramstr(serial, serial->serialcomm);
-       else
-               return SR_OK;
+       if (serial->serialcomm) {
+               ret = serial_set_paramstr(serial, serial->serialcomm);
+               if (ret != SR_OK)
+                       return ret;
+       }
+
+       /*
+        * Flush potentially dangling RX data. Availability of the
+        * flush primitive depends on the transport/cable, absense
+        * is non-fatal.
+        */
+       ret = serial_flush(serial);
+       if (ret == SR_ERR_NA)
+               ret = SR_OK;
+       if (ret != SR_OK)
+               return ret;
+
+       return SR_OK;
 }
 
 /**
@@ -98,6 +154,8 @@ 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 rc;
+
        if (!serial) {
                sr_dbg("Invalid serial port.");
                return SR_ERR;
@@ -105,7 +163,16 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 
        sr_spew("Closing serial port %s.", serial->port);
 
-       return sr_ser_libsp_close(serial);
+       if (!serial->lib_funcs || !serial->lib_funcs->close)
+               return SR_ERR_NA;
+
+       rc = serial->lib_funcs->close(serial);
+       if (rc == SR_OK && serial->rcv_buffer) {
+               g_string_free(serial->rcv_buffer, TRUE);
+               serial->rcv_buffer = NULL;
+       }
+
+       return rc;
 }
 
 /**
@@ -127,7 +194,12 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 
        sr_spew("Flushing serial port %s.", serial->port);
 
-       return sr_ser_libsp_flush(serial);
+       sr_ser_discard_queued_data(serial);
+
+       if (!serial->lib_funcs || !serial->lib_funcs->flush)
+               return SR_ERR_NA;
+
+       return serial->lib_funcs->flush(serial);
 }
 
 /**
@@ -149,7 +221,173 @@ SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
 
        sr_spew("Draining serial port %s.", serial->port);
 
-       return sr_ser_libsp_drain(serial);
+       if (!serial->lib_funcs || !serial->lib_funcs->drain)
+               return SR_ERR_NA;
+
+       return serial->lib_funcs->drain(serial);
+}
+
+/*
+ * Provide an internal RX data buffer for the serial port. This is not
+ * supposed to be used directly by applications. Instead optional and
+ * alternative transports for serial communication can use this buffer
+ * if their progress is driven from background activity, and is not
+ * (directly) driven by external API calls.
+ *
+ * BEWARE! This implementation assumes that data which gets communicated
+ * via UART can get stored in a GString (which is a char array). Since
+ * the API hides this detail, we can address this issue later when needed.
+ * Callers use the API which communicates bytes.
+ *
+ * Applications optionally can register a "per RX chunk" callback, when
+ * they depend on the frame boundaries of the respective physical layer.
+ * Most callers just want the stream of RX data, and can use the buffer.
+ *
+ * The availability of RX chunks to callbacks, as well as the capability
+ * to pass on exact frames as chunks or potential re-assembly of chunks
+ * to a single data block, depend on each transport's implementation.
+ */
+
+/**
+ * Register application callback for RX data chunks.
+ *
+ * @param[in] serial Previously initialized serial port instance.
+ * @param[in] cb Routine to call as RX data becomes available.
+ * @param[in] cb_data User data to pass to the callback in addition to RX data.
+ *
+ * @retval SR_ERR_ARG Invalid parameters.
+ * @retval SR_OK Successful registration.
+ *
+ * Callbacks get unregistered by specifying NULL for the 'cb' parameter.
+ *
+ * @private
+ */
+SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
+       serial_rx_chunk_callback cb, void *cb_data)
+{
+       if (!serial)
+               return SR_ERR_ARG;
+
+       serial->rx_chunk_cb_func = cb;
+       serial->rx_chunk_cb_data = cb_data;
+
+       return SR_OK;
+}
+
+/**
+ * Discard previously queued RX data. Internal to the serial subsystem,
+ * coordination between common and transport specific support code.
+ *
+ * @param[in] serial Previously opened serial port instance.
+ *
+ * @private
+ */
+SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial)
+{
+       if (!serial || !serial->rcv_buffer)
+               return;
+
+       g_string_truncate(serial->rcv_buffer, 0);
+}
+
+/**
+ * Get amount of queued RX data. Internal to the serial subsystem,
+ * coordination between common and transport specific support code.
+ *
+ * @param[in] serial Previously opened serial port instance.
+ *
+ * @private
+ */
+SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial)
+{
+       if (!serial || !serial->rcv_buffer)
+               return 0;
+
+       return serial->rcv_buffer->len;
+}
+
+/**
+ * Queue received data. Internal to the serial subsystem, coordination
+ * between common and transport specific support code.
+ *
+ * @param[in] serial Previously opened serial port instance.
+ * @param[in] data Pointer to data bytes to queue.
+ * @param[in] len Number of data bytes to queue.
+ *
+ * @private
+ */
+SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
+       const uint8_t *data, size_t len)
+{
+       if (!serial || !data || !len)
+               return;
+
+       if (serial->rx_chunk_cb_func)
+               serial->rx_chunk_cb_func(serial, serial->rx_chunk_cb_data, data, len);
+       else if (serial->rcv_buffer)
+               g_string_append_len(serial->rcv_buffer, (const gchar *)data, len);
+}
+
+/**
+ * Retrieve previously queued RX data. Internal to the serial subsystem,
+ * coordination between common and transport specific support code.
+ *
+ * @param[in] serial Previously opened serial port instance.
+ * @param[out] data Pointer to store retrieved data bytes into.
+ * @param[in] len Number of data bytes to retrieve.
+ *
+ * @private
+ */
+SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
+       uint8_t *data, size_t len)
+{
+       size_t qlen;
+       GString *buf;
+
+       if (!serial || !data || !len)
+               return 0;
+
+       qlen = sr_ser_has_queued_data(serial);
+       if (!qlen)
+               return 0;
+
+       buf = serial->rcv_buffer;
+       if (len > buf->len)
+               len = buf->len;
+       if (len) {
+               memcpy(data, buf->str, len);
+               g_string_erase(buf, 0, len);
+       }
+
+       return len;
+}
+
+/**
+ * Check for available receive data.
+ *
+ * @param[in] serial Previously opened serial port instance.
+ *
+ * @returns The number of (known) available RX data bytes.
+ *
+ * Returns 0 if no receive data is available, or if the amount of
+ * available receive data cannot get determined.
+ *
+ * @private
+ */
+SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial)
+{
+       size_t lib_count, buf_count;
+
+       if (!serial)
+               return 0;
+
+       lib_count = 0;
+       if (serial->lib_funcs && serial->lib_funcs->get_rx_avail)
+               lib_count = serial->lib_funcs->get_rx_avail(serial);
+
+       buf_count = sr_ser_has_queued_data(serial);
+
+       return lib_count + buf_count;
 }
 
 static int _serial_write(struct sr_serial_dev_inst *serial,
@@ -163,7 +401,10 @@ static int _serial_write(struct sr_serial_dev_inst *serial,
                return SR_ERR;
        }
 
-       ret = sr_ser_libsp_write(serial, buf, count, nonblocking, timeout_ms);
+       if (!serial->lib_funcs || !serial->lib_funcs->write)
+               return SR_ERR_NA;
+       ret = serial->lib_funcs->write(serial, buf, count,
+               nonblocking, timeout_ms);
        sr_spew("Wrote %zd/%zu bytes.", ret, count);
 
        return ret;
@@ -219,7 +460,10 @@ static int _serial_read(struct sr_serial_dev_inst *serial,
                return SR_ERR;
        }
 
-       ret = sr_ser_libsp_read(serial, buf, count, nonblocking, timeout_ms);
+       if (!serial->lib_funcs || !serial->lib_funcs->read)
+               return SR_ERR_NA;
+       ret = serial->lib_funcs->read(serial, buf, count,
+               nonblocking, timeout_ms);
        if (ret > 0)
                sr_spew("Read %zd/%zu bytes.", ret, count);
 
@@ -298,8 +542,11 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial,
 
        sr_spew("Setting serial parameters on port %s.", serial->port);
 
-       ret = sr_ser_libsp_set_params(serial,
-               baudrate, bits, parity, stopbits, flowcontrol, rts, dtr);
+       if (!serial->lib_funcs || !serial->lib_funcs->set_params)
+               return SR_ERR_NA;
+       ret = serial->lib_funcs->set_params(serial,
+               baudrate, bits, parity, stopbits,
+               flowcontrol, rts, dtr);
        if (ret == SR_OK) {
                serial->comm_params.bit_rate = baudrate;
                serial->comm_params.data_bits = bits;
@@ -314,6 +561,37 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial,
        return ret;
 }
 
+/**
+ * Manipulate handshake state for the specified serial port.
+ *
+ * @param serial Previously initialized serial port structure.
+ * @param[in] rts Status of RTS line (0 or 1; or -1 to ignore).
+ * @param[in] dtr Status of DTR line (0 or 1; or -1 to ignore).
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR Failure.
+ *
+ * @private
+ */
+SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
+       int rts, int dtr)
+{
+       int ret;
+
+       if (!serial) {
+               sr_dbg("Invalid serial port.");
+               return SR_ERR;
+       }
+
+       sr_spew("Modifying serial parameters on port %s.", serial->port);
+
+       if (!serial->lib_funcs || !serial->lib_funcs->set_handshake)
+               return SR_ERR_NA;
+       ret = serial->lib_funcs->set_handshake(serial, rts, dtr);
+
+       return ret;
+}
+
 /**
  * Set serial parameters for the specified serial port from parameter string.
  *
@@ -341,7 +619,7 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
        const char *paramstr)
 {
 /** @cond PRIVATE */
-#define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
+#define SERIAL_COMM_SPEC "^(\\d+)(/([5678])([neo])([12]))?(.*)$"
 /** @endcond */
 
        GRegex *reg;
@@ -349,7 +627,10 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
        int speed, databits, parity, stopbits, flow, rts, dtr, i;
        char *mstr, **opts, **kv;
 
-       speed = databits = parity = stopbits = flow = 0;
+       speed = flow = 0;
+       databits = 8;
+       parity = SP_PARITY_NONE;
+       stopbits = 1;
        rts = dtr = -1;
        sr_spew("Parsing parameters from \"%s\".", paramstr);
        reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
@@ -357,10 +638,10 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
                if ((mstr = g_match_info_fetch(match, 1)))
                        speed = strtoul(mstr, NULL, 10);
                g_free(mstr);
-               if ((mstr = g_match_info_fetch(match, 2)))
+               if ((mstr = g_match_info_fetch(match, 3)) && mstr[0])
                        databits = strtoul(mstr, NULL, 10);
                g_free(mstr);
-               if ((mstr = g_match_info_fetch(match, 3))) {
+               if ((mstr = g_match_info_fetch(match, 4)) && mstr[0]) {
                        switch (mstr[0]) {
                        case 'n':
                                parity = SP_PARITY_NONE;
@@ -374,10 +655,10 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
                        }
                }
                g_free(mstr);
-               if ((mstr = g_match_info_fetch(match, 4)))
+               if ((mstr = g_match_info_fetch(match, 5)) && mstr[0])
                        stopbits = strtoul(mstr, NULL, 10);
                g_free(mstr);
-               if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
+               if ((mstr = g_match_info_fetch(match, 6)) && mstr[0] != '\0') {
                        if (mstr[0] != '/') {
                                sr_dbg("missing separator before extra options");
                                speed = 0;
@@ -425,14 +706,17 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
        }
        g_match_info_unref(match);
        g_regex_unref(reg);
+       sr_spew("Got params: rate %d, frame %d/%d/%d, flow %d, rts %d, dtr %d.",
+               speed, databits, parity, stopbits, flow, rts, dtr);
 
-       if (speed) {
-               return serial_set_params(serial, speed, databits, parity,
-                                        stopbits, flow, rts, dtr);
-       } else {
+       if (!speed) {
                sr_dbg("Could not infer speed from parameter string.");
                return SR_ERR_ARG;
        }
+
+       return serial_set_params(serial, speed,
+                       databits, parity, stopbits,
+                       flow, rts, dtr);
 }
 
 /**
@@ -461,7 +745,7 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial,
                return SR_ERR;
        }
 
-       if (!serial->sp_data) {
+       if (!dev_is_supported(serial)) {
                sr_dbg("Cannot use unopened serial port %s.", serial->port);
                return -1;
        }
@@ -503,16 +787,23 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial,
 /**
  * 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 buflen Size of the buffer.
+ * @param[in] serial Previously initialized serial port structure.
+ * @param[in] buf Buffer containing the bytes to write.
+ * @param[in] buflen Size of the buffer.
  * @param[in] packet_size Size, in bytes, of a valid packet.
- * @param is_valid Callback that assesses whether the packet is valid or not.
+ * @param[in] is_valid Callback that assesses whether the packet is valid or not.
+ * @param[in] is_valid_len Callback which checks a variable length packet.
+ * @param[out] return_size Detected packet size in case of successful match.
  * @param[in] timeout_ms The timeout after which, if no packet is detected, to
  *                       abort scanning.
- * @param[in] baudrate The baudrate of the serial port. This parameter is not
- *                     critical, but it helps fine tune the serial port polling
- *                     delay.
+ *
+ * Data is received from the serial port and into the caller provided
+ * buffer, until the buffer is exhausted, or the timeout has expired,
+ * or a valid packet was found. Receive data is passed to the caller
+ * provided validity check routine, assuming either fixed size packets
+ * (#is_valid parameter, exact match to the #packet_size length) or
+ * packets of variable length (#is_valid_len parameter, minimum length
+ * #packet_size required for first invocation).
  *
  * @retval SR_OK Valid packet was found within the given timeout.
  * @retval SR_ERR Failure.
@@ -521,72 +812,115 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial,
  */
 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
        uint8_t *buf, size_t *buflen,
-       size_t packet_size,
-       packet_valid_callback is_valid,
-       uint64_t timeout_ms, int baudrate)
+       size_t packet_size, packet_valid_callback is_valid,
+       packet_valid_len_callback is_valid_len, size_t *return_size,
+       uint64_t timeout_ms)
 {
-       uint64_t start, time, byte_delay_us;
-       size_t ibuf, i, maxlen;
-       ssize_t len;
-
-       maxlen = *buflen;
-
-       sr_dbg("Detecting packets on %s (timeout = %" PRIu64
-              "ms, baudrate = %d).", serial->port, timeout_ms, baudrate);
+       uint64_t start_us, elapsed_ms, byte_delay_us;
+       size_t fill_idx, check_idx, max_fill_idx;
+       ssize_t recv_len;
+       const uint8_t *check_ptr;
+       size_t check_len, pkt_len;
+       gboolean do_dump;
+       int ret;
 
-       if (maxlen < (packet_size / 2) ) {
-               sr_err("Buffer size must be at least twice the packet size.");
-               return SR_ERR;
+       sr_dbg("Detecting packets on %s (timeout = %" PRIu64 "ms).",
+               serial->port, timeout_ms);
+
+       max_fill_idx = *buflen;
+       if (max_fill_idx < 2 * packet_size) {
+               /*
+                * The heuristics in this check is only useful for fixed
+                * packet length scenarios, but for variable length setups
+                * we don't know the packets' sizes up front.
+                */
+               sr_err("Small stream detect RX buffer, want 2x packet size.");
+               return SR_ERR_ARG;
        }
 
-       /* Assume 8n1 transmission. That is 10 bits for every byte. */
-       byte_delay_us = 10 * ((1000 * 1000) / baudrate);
-       start = g_get_monotonic_time();
+       byte_delay_us = serial_timeout(serial, 1) * 1000;
+       start_us = g_get_monotonic_time();
+
+       check_idx = fill_idx = 0;
+       while (fill_idx < max_fill_idx) {
+               /*
+                * Read bytes individually. Lets callers continue to
+                * successfully process next RX data after first match.
+                * Run full loop bodies for empty or failed reception
+                * in an iteration, to have timeouts checked.
+                */
+               recv_len = serial_read_nonblocking(serial, &buf[fill_idx], 1);
+               if (recv_len > 0)
+                       fill_idx += recv_len;
+
+               /* Dump receive data when (a minimum) size is reached. */
+               check_ptr = &buf[check_idx];
+               check_len = fill_idx - check_idx;
+               do_dump = check_len >= packet_size;
+               do_dump &= sr_log_loglevel_get() >= SR_LOG_SPEW;
+               if (do_dump) {
+                       GString *text;
 
-       i = ibuf = len = 0;
-       while (ibuf < maxlen) {
-               len = serial_read_nonblocking(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. */
+                       text = sr_hexdump_new(check_ptr, check_len);
+                       sr_spew("Trying packet: len %zu, bytes %s",
+                               check_len, text->str);
+                       sr_hexdump_free(text);
                }
 
-               time = g_get_monotonic_time() - start;
-               time /= 1000;
-
-               if ((ibuf - i) >= packet_size) {
-                       GString *text;
-                       /* We have at least a packet's worth of data. */
-                       text = sr_hexdump_new(&buf[i], packet_size);
-                       sr_spew("Trying packet: %s", text->str);
-                       sr_hexdump_free(text);
-                       if (is_valid(&buf[i])) {
-                               sr_spew("Found valid %zu-byte packet after "
-                                       "%" PRIu64 "ms.", (ibuf - i), time);
-                               *buflen = ibuf;
+               /* A packet's (minimum) length was received, check its data. */
+               elapsed_ms = g_get_monotonic_time() - start_us;
+               elapsed_ms /= 1000;
+               if (is_valid_len && check_len >= packet_size) {
+                       pkt_len = packet_size;
+                       ret = is_valid_len(NULL, check_ptr, check_len, &pkt_len);
+                       if (ret == SR_PACKET_VALID) {
+                               /* Exact match. Terminate with success. */
+                               sr_spew("Valid packet after %" PRIu64 "ms.",
+                                       elapsed_ms);
+                               sr_spew("RX count %zu, packet len %zu.",
+                                       fill_idx, pkt_len);
+                               *buflen = fill_idx;
+                               if (return_size)
+                                       *return_size = pkt_len;
                                return SR_OK;
+                       }
+                       if (ret == SR_PACKET_NEED_RX) {
+                               /* Incomplete, keep accumulating RX data. */
+                               sr_spew("Checker needs more RX data.");
                        } else {
-                               sr_spew("Got %zu bytes, but not a valid "
-                                       "packet.", (ibuf - i));
+                               /* Not a valid packet. Continue searching. */
+                               sr_spew("Invalid packet, advancing read pos.");
+                               check_idx++;
+                       }
+               }
+               if (is_valid && check_len >= packet_size) {
+                       if (is_valid(check_ptr)) {
+                               /* Exact match. Terminate with success. */
+                               sr_spew("Valid packet after %" PRIu64 "ms.",
+                                       elapsed_ms);
+                               sr_spew("RX count %zu, packet len %zu.",
+                                       fill_idx, packet_size);
+                               *buflen = fill_idx;
+                               if (return_size)
+                                       *return_size = packet_size;
+                               return SR_OK;
                        }
                        /* Not a valid packet. Continue searching. */
-                       i++;
+                       sr_spew("Invalid packet, advancing read pointer.");
+                       check_idx++;
                }
-               if (time >= timeout_ms) {
-                       /* Timeout */
-                       sr_dbg("Detection timed out after %" PRIu64 "ms.", time);
+
+               /* Check for packet search timeout. */
+               if (elapsed_ms >= timeout_ms) {
+                       sr_dbg("Detection timed out after %" PRIu64 "ms.",
+                               elapsed_ms);
                        break;
                }
-               if (len < 1)
+               if (recv_len < 1)
                        g_usleep(byte_delay_us);
        }
-
-       *buflen = ibuf;
-
-       sr_err("Didn't find a valid packet (read %zu bytes).", *buflen);
+       sr_info("Didn't find a valid packet (read %zu bytes).", fill_idx);
+       *buflen = fill_idx;
 
        return SR_ERR;
 }
@@ -594,13 +928,20 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 /**
  * 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 extracted serial device.
- * @param serial_options Pointer where to store the optional extracted serial
+ * The caller's passed in references get updated when the list of options
+ * contains one of the desired parameters. This lets callers pre-assign
+ * default values which take effect in the absence of user specifications.
+ * Either reference is optional, passing #NULL is acceptable.
+ *
+ * Callers must not free returned strings. These shall be considered
+ * read-only handles to data that is managed elsewhere.
+ *
+ * @param[in] options List of options passed from the command line.
+ * @param[out] serial_device Pointer where to store the extracted serial device.
+ * @param[out] 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.
+ * @return SR_OK if a serial_device is found, SR_ERR if no device is found.
  *
  * @private
  */
@@ -610,23 +951,25 @@ SR_PRIV int sr_serial_extract_options(GSList *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:
+                       if (!serial_device)
+                               break;
                        *serial_device = g_variant_get_string(src->data, NULL);
                        sr_dbg("Parsed serial device: %s.", *serial_device);
                        break;
                case SR_CONF_SERIALCOMM:
+                       if (!serial_options)
+                               break;
                        *serial_options = g_variant_get_string(src->data, NULL);
                        sr_dbg("Parsed serial options: %s.", *serial_options);
                        break;
                }
        }
 
-       if (!*serial_device) {
+       if (serial_device && !*serial_device) {
                sr_dbg("No serial device specified.");
                return SR_ERR;
        }
@@ -644,12 +987,15 @@ SR_PRIV int serial_source_add(struct sr_session *session,
                return SR_ERR_ARG;
        }
 
-       if (!serial->sp_data) {
+       if (!dev_is_supported(serial)) {
                sr_err("Invalid serial port.");
                return SR_ERR_ARG;
        }
 
-       return sr_ser_libsp_source_add(session, serial,
+       if (!serial->lib_funcs || !serial->lib_funcs->setup_source_add)
+               return SR_ERR_NA;
+
+       return serial->lib_funcs->setup_source_add(session, serial,
                events, timeout, cb, cb_data);
 }
 
@@ -657,12 +1003,15 @@ SR_PRIV int serial_source_add(struct sr_session *session,
 SR_PRIV int serial_source_remove(struct sr_session *session,
        struct sr_serial_dev_inst *serial)
 {
-       if (!serial->sp_data) {
+       if (!dev_is_supported(serial)) {
                sr_err("Invalid serial port.");
                return SR_ERR_ARG;
        }
 
-       return sr_ser_libsp_source_remove(session, serial);
+       if (!serial->lib_funcs || !serial->lib_funcs->setup_source_remove)
+               return SR_ERR_NA;
+
+       return serial->lib_funcs->setup_source_remove(session, serial);
 }
 
 /**
@@ -719,12 +1068,24 @@ static GSList *append_port_list(GSList *devs, const char *name, const char *desc
 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver)
 {
        GSList *tty_devs;
+       GSList *(*list_func)(GSList *list, sr_ser_list_append_t append);
 
        /* Currently unused, but will be used by some drivers later on. */
        (void)driver;
 
        tty_devs = NULL;
-       tty_devs = sr_ser_libsp_list(tty_devs, append_port_list);
+       if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->list) {
+               list_func = ser_lib_funcs_libsp->list;
+               tty_devs = list_func(tty_devs, append_port_list);
+       }
+       if (ser_lib_funcs_hid && ser_lib_funcs_hid->list) {
+               list_func = ser_lib_funcs_hid->list;
+               tty_devs = list_func(tty_devs, append_port_list);
+       }
+       if (ser_lib_funcs_bt && ser_lib_funcs_bt->list) {
+               list_func = ser_lib_funcs_bt->list;
+               tty_devs = list_func(tty_devs, append_port_list);
+       }
 
        return tty_devs;
 }
@@ -752,10 +1113,20 @@ static GSList *append_port_find(GSList *devs, const char *name)
 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
 {
        GSList *tty_devs;
+       GSList *(*find_func)(GSList *list, sr_ser_find_append_t append,
+                       uint16_t vid, uint16_t pid);
 
        tty_devs = NULL;
-       tty_devs = sr_ser_libsp_find_usb(tty_devs, append_port_find,
-               vendor_id, product_id);
+       if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->find_usb) {
+               find_func = ser_lib_funcs_libsp->find_usb;
+               tty_devs = find_func(tty_devs, append_port_find,
+                       vendor_id, product_id);
+       }
+       if (ser_lib_funcs_hid && ser_lib_funcs_hid->find_usb) {
+               find_func = ser_lib_funcs_hid->find_usb;
+               tty_devs = find_func(tty_devs, append_port_find,
+                       vendor_id, product_id);
+       }
 
        return tty_devs;
 }
@@ -763,16 +1134,15 @@ SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
 /** @private */
 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
 {
-       int bits, baud;
-       int ret;
-       int timeout_ms;
+       int bits, baud, ret, timeout_ms;
 
        /* Get the bitrate and frame length. */
        bits = baud = 0;
-       ret = sr_ser_libsp_get_frame_format(port, &baud, &bits);
-       if (ret != SR_OK)
-               bits = baud = 0;
-       if (!bits || !baud) {
+       if (port->lib_funcs && port->lib_funcs->get_frame_format) {
+               ret = port->lib_funcs->get_frame_format(port, &baud, &bits);
+               if (ret != SR_OK)
+                       bits = baud = 0;
+       } else {
                baud = port->comm_params.bit_rate;
                bits = 1 + port->comm_params.data_bits +
                        port->comm_params.parity_bits +
@@ -790,4 +1160,10 @@ SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
        return timeout_ms;
 }
 
+#else
+
+/* TODO Put fallback.c content here? */
+
+#endif
+
 /** @} */