* 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
#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.
*
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.");
sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
- 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;
+ /*
+ * 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;
- ret = sp_open(serial->data, sp_flags);
+ /*
+ * 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.
+ */
- 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 (%d): %s.",
- sp_last_error_code(), error);
- sp_free_error_message(error);
- return SR_ERR;
+ /*
+ * 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) {
+ ret = serial_set_paramstr(serial, serial->serialcomm);
+ if (ret != SR_OK)
+ return ret;
}
- if (serial->serialcomm)
- return serial_set_paramstr(serial, serial->serialcomm);
- else
- return SR_OK;
+ /*
+ * 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;
}
/**
*/
SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
{
- int ret;
- char *error;
+ int rc;
if (!serial) {
sr_dbg("Invalid serial port.");
return SR_ERR;
}
- if (!serial->data) {
- sr_dbg("Cannot close unopened serial port %s.", serial->port);
- return SR_ERR;
- }
-
sr_spew("Closing serial port %s.", serial->port);
- ret = sp_close(serial->data);
+ if (!serial->lib_funcs || !serial->lib_funcs->close)
+ return SR_ERR_NA;
- 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 (%d): %s.",
- sp_last_error_code(), error);
- sp_free_error_message(error);
- return SR_ERR;
+ rc = serial->lib_funcs->close(serial);
+ if (rc == SR_OK && serial->rcv_buffer) {
+ g_string_free(serial->rcv_buffer, TRUE);
+ serial->rcv_buffer = NULL;
}
- sp_free_port(serial->data);
- serial->data = NULL;
-
- return SR_OK;
+ return rc;
}
/**
*/
SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
{
- int ret;
- char *error;
-
if (!serial) {
sr_dbg("Invalid serial port.");
return SR_ERR;
}
- if (!serial->data) {
- sr_dbg("Cannot flush unopened serial port %s.", serial->port);
- return SR_ERR;
- }
-
sr_spew("Flushing serial port %s.", serial->port);
- ret = sp_flush(serial->data, SP_BUF_BOTH);
+ sr_ser_discard_queued_data(serial);
- 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 (%d): %s.",
- sp_last_error_code(), error);
- sp_free_error_message(error);
- return SR_ERR;
- }
+ if (!serial->lib_funcs || !serial->lib_funcs->flush)
+ return SR_ERR_NA;
- return SR_OK;
+ return serial->lib_funcs->flush(serial);
}
/**
*/
SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
{
- int ret;
- char *error;
-
if (!serial) {
sr_dbg("Invalid serial port.");
return SR_ERR;
}
- if (!serial->data) {
- sr_dbg("Cannot drain unopened serial port %s.", serial->port);
- return SR_ERR;
- }
-
sr_spew("Draining serial port %s.", serial->port);
- ret = sp_drain(serial->data);
+ if (!serial->lib_funcs || !serial->lib_funcs->drain)
+ return SR_ERR_NA;
- if (ret == SP_ERR_FAIL) {
- error = sp_last_error_message();
- sr_err("Error draining port (%d): %s.",
- sp_last_error_code(), error);
- sp_free_error_message(error);
- return SR_ERR;
- }
+ 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;
}
-static int _serial_write(struct sr_serial_dev_inst *serial,
- const void *buf, size_t count, int nonblocking, unsigned int timeout_ms)
+/**
+ * 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)
{
- ssize_t ret;
- char *error;
+ if (!serial || !serial->rcv_buffer)
+ return;
- if (!serial) {
- sr_dbg("Invalid serial port.");
- return SR_ERR;
- }
+ g_string_truncate(serial->rcv_buffer, 0);
+}
- if (!serial->data) {
- sr_dbg("Cannot use unopened serial port %s.", serial->port);
- return SR_ERR;
+/**
+ * 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);
}
- if (nonblocking)
- ret = sp_nonblocking_write(serial->data, buf, count);
- else
- ret = sp_blocking_write(serial->data, buf, count, timeout_ms);
+ return len;
+}
- 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 (%d): %s.", sp_last_error_code(), error);
- sp_free_error_message(error);
+/**
+ * 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,
+ const void *buf, size_t count,
+ int nonblocking, unsigned int timeout_ms)
+{
+ ssize_t ret;
+
+ if (!serial) {
+ sr_dbg("Invalid serial port.");
return SR_ERR;
}
+ 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;
* @private
*/
SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
- const void *buf, size_t count, unsigned int timeout_ms)
+ const void *buf, size_t count, unsigned int timeout_ms)
{
return _serial_write(serial, buf, count, 0, timeout_ms);
}
* @private
*/
SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
- const void *buf, size_t count)
+ const void *buf, size_t count)
{
return _serial_write(serial, buf, count, 1, 0);
}
-static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
- size_t count, int nonblocking, unsigned int timeout_ms)
+static int _serial_read(struct sr_serial_dev_inst *serial,
+ void *buf, size_t count, int nonblocking, unsigned int timeout_ms)
{
ssize_t ret;
- char *error;
if (!serial) {
sr_dbg("Invalid serial port.");
return SR_ERR;
}
- if (!serial->data) {
- sr_dbg("Cannot use unopened serial port %s.", serial->port);
- return SR_ERR;
- }
-
- if (nonblocking)
- ret = sp_nonblocking_read(serial->data, buf, count);
- else
- ret = sp_blocking_read(serial->data, buf, count, timeout_ms);
-
- 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 (%d): %s.", sp_last_error_code(), error);
- sp_free_error_message(error);
- return SR_ERR;
- }
-
+ 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);
*
* @private
*/
-SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
- size_t count, unsigned int timeout_ms)
+SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial,
+ void *buf, size_t count, unsigned int timeout_ms)
{
return _serial_read(serial, buf, count, 0, timeout_ms);
}
*
* @private
*/
-SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
- size_t count)
+SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial,
+ void *buf, size_t count)
{
return _serial_read(serial, buf, count, 1, 0);
}
*
* @private
*/
-SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
- int bits, int parity, int stopbits,
- int flowcontrol, int rts, int dtr)
+SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial,
+ int baudrate, 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.");
return SR_ERR;
}
- if (!serial->data) {
- sr_dbg("Cannot configure unopened serial port %s.", serial->port);
- return SR_ERR;
- }
-
sr_spew("Setting serial parameters on port %s.", serial->port);
- sp_new_config(&config);
- sp_set_config_baudrate(config, baudrate);
- sp_set_config_bits(config, bits);
- switch (parity) {
- case 0:
- sp_set_config_parity(config, SP_PARITY_NONE);
- break;
- case 1:
- sp_set_config_parity(config, SP_PARITY_EVEN);
- break;
- case 2:
- sp_set_config_parity(config, SP_PARITY_ODD);
- break;
- default:
- return SR_ERR_ARG;
+ 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;
+ serial->comm_params.parity_bits = parity ? 1 : 0;
+ serial->comm_params.stop_bits = stopbits;
+ sr_dbg("DBG: %s() rate %d, %d%s%d", __func__,
+ baudrate, bits,
+ (parity == 0) ? "n" : "x",
+ stopbits);
}
- 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 (%d): %s.",
- sp_last_error_code(), error);
- sp_free_error_message(error);
+
+ 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;
}
- return SR_OK;
+ 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;
}
/**
* @private
*/
SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
- const char *paramstr)
+ const char *paramstr)
{
/** @cond PRIVATE */
-#define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
+#define SERIAL_COMM_SPEC "^(\\d+)(/([5678])([neo])([12]))?(.*)$"
/** @endcond */
GRegex *reg;
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);
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;
}
}
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;
}
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);
}
/**
*
* @private
*/
-SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
- int *buflen, gint64 timeout_ms)
+SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial,
+ char **buf, int *buflen, gint64 timeout_ms)
{
gint64 start, remaining;
int maxlen, len;
return SR_ERR;
}
- if (!serial->data) {
+ if (!dev_is_supported(serial)) {
sr_dbg("Cannot use unopened serial port %s.", serial->port);
return -1;
}
len = maxlen - *buflen - 1;
if (len < 1)
break;
- len = sp_blocking_read(serial->data, *buf + *buflen, 1, remaining);
+ len = serial_read_blocking(serial, *buf + *buflen, 1, remaining);
if (len > 0) {
*buflen += len;
*(*buf + *buflen) = '\0';
/**
* 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.
* @private
*/
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)
+ uint8_t *buf, size_t *buflen,
+ 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;
}
/**
* 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
*/
-SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
- const char **serial_options)
+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:
+ 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;
}
return SR_OK;
}
-/** @cond PRIVATE */
-#ifdef _WIN32
-typedef HANDLE event_handle;
-#else
-typedef int event_handle;
-#endif
-/** @endcond */
-
/** @private */
SR_PRIV int serial_source_add(struct sr_session *session,
- struct sr_serial_dev_inst *serial, int events, int timeout,
- sr_receive_data_callback cb, void *cb_data)
+ struct sr_serial_dev_inst *serial, int events, int timeout,
+ sr_receive_data_callback cb, void *cb_data)
{
- struct sp_event_set *event_set;
- gintptr poll_fd;
- unsigned int poll_events;
- enum sp_event mask = 0;
-
- if ((events & (G_IO_IN|G_IO_ERR)) && (events & G_IO_OUT)) {
+ if ((events & (G_IO_IN | G_IO_ERR)) && (events & G_IO_OUT)) {
sr_err("Cannot poll input/error and output simultaneously.");
return SR_ERR_ARG;
}
- if (sp_new_event_set(&event_set) != SP_OK)
- return SR_ERR;
-
- if (events & G_IO_IN)
- mask |= SP_EVENT_RX_READY;
- if (events & G_IO_OUT)
- mask |= SP_EVENT_TX_READY;
- if (events & G_IO_ERR)
- mask |= SP_EVENT_ERROR;
-
- if (sp_add_port_events(event_set, serial->data, mask) != SP_OK) {
- sp_free_event_set(event_set);
- return SR_ERR;
- }
- if (event_set->count != 1) {
- sr_err("Unexpected number (%u) of event handles to poll.",
- event_set->count);
- sp_free_event_set(event_set);
- return SR_ERR;
+ if (!dev_is_supported(serial)) {
+ sr_err("Invalid serial port.");
+ return SR_ERR_ARG;
}
- poll_fd = (gintptr) ((event_handle *)event_set->handles)[0];
- mask = event_set->masks[0];
-
- sp_free_event_set(event_set);
+ if (!serial->lib_funcs || !serial->lib_funcs->setup_source_add)
+ return SR_ERR_NA;
- poll_events = 0;
- if (mask & SP_EVENT_RX_READY)
- poll_events |= G_IO_IN;
- if (mask & SP_EVENT_TX_READY)
- poll_events |= G_IO_OUT;
- if (mask & SP_EVENT_ERROR)
- poll_events |= G_IO_ERR;
- /*
- * Using serial->data as the key for the event source is not quite
- * proper, as it makes it impossible to create another event source
- * for the same serial port. However, these fixed keys will soon be
- * removed from the API anyway, so this is OK for now.
- */
- return sr_session_fd_source_add(session, serial->data,
- poll_fd, poll_events, timeout, cb, cb_data);
+ return serial->lib_funcs->setup_source_add(session, serial,
+ events, timeout, cb, cb_data);
}
/** @private */
SR_PRIV int serial_source_remove(struct sr_session *session,
- struct sr_serial_dev_inst *serial)
+ struct sr_serial_dev_inst *serial)
{
- return sr_session_source_remove_internal(session, serial->data);
+ if (!dev_is_supported(serial)) {
+ sr_err("Invalid serial port.");
+ return SR_ERR_ARG;
+ }
+
+ if (!serial->lib_funcs || !serial->lib_funcs->setup_source_remove)
+ return SR_ERR_NA;
+
+ return serial->lib_funcs->setup_source_remove(session, serial);
}
/**
* @return The newly allocated sr_serial_port struct.
*/
static struct sr_serial_port *sr_serial_new(const char *name,
- const char *description)
+ const char *description)
{
struct sr_serial_port *serial;
g_free(serial);
}
+static GSList *append_port_list(GSList *devs, const char *name, const char *desc)
+{
+ return g_slist_append(devs, sr_serial_new(name, desc));
+}
+
/**
* List available serial devices.
*
*/
SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver)
{
- GSList *tty_devs = NULL;
- struct sp_port **ports;
- struct sr_serial_port *port;
- int i;
+ 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;
- if (sp_list_ports(&ports) != SP_OK)
- return NULL;
-
- for (i = 0; ports[i]; i++) {
- port = sr_serial_new(sp_get_port_name(ports[i]),
- sp_get_port_description(ports[i]));
- tty_devs = g_slist_append(tty_devs, port);
+ tty_devs = NULL;
+ 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);
}
-
- sp_free_port_list(ports);
return tty_devs;
}
+static GSList *append_port_find(GSList *devs, const char *name)
+{
+ if (!name || !*name)
+ return devs;
+
+ return g_slist_append(devs, g_strdup(name));
+}
+
/**
* Find USB serial devices via the USB vendor ID and product ID.
*
*/
SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
{
- GSList *tty_devs = NULL;
- struct sp_port **ports;
- int i, vid, pid;
-
- if (sp_list_ports(&ports) != SP_OK)
- return NULL;
-
- for (i = 0; ports[i]; i++)
- if (sp_get_port_transport(ports[i]) == SP_TRANSPORT_USB &&
- sp_get_port_usb_vid_pid(ports[i], &vid, &pid) == SP_OK &&
- vid == vendor_id && pid == product_id) {
- tty_devs = g_slist_prepend(tty_devs,
- g_strdup(sp_get_port_name(ports[i])));
- }
-
- sp_free_port_list(ports);
+ GSList *tty_devs;
+ GSList *(*find_func)(GSList *list, sr_ser_find_append_t append,
+ uint16_t vid, uint16_t pid);
+
+ tty_devs = NULL;
+ 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;
}
/** @private */
SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
{
- struct sp_port_config *config;
- int timeout_ms, bits, baud, tmp;
-
- /* Default to 1s. */
- timeout_ms = 1000;
-
- if (sp_new_config(&config) < 0)
- return timeout_ms;
+ int bits, baud, ret, timeout_ms;
+ /* Get the bitrate and frame length. */
bits = baud = 0;
- do {
- if (sp_get_config(port->data, config) < 0)
- break;
-
- /* Start bit. */
- bits = 1;
- if (sp_get_config_bits(config, &tmp) < 0)
- break;
- bits += tmp;
- if (sp_get_config_stopbits(config, &tmp) < 0)
- break;
- bits += tmp;
- if (sp_get_config_baudrate(config, &tmp) < 0)
- break;
- baud = tmp;
- } while (FALSE);
+ 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 +
+ port->comm_params.stop_bits;
+ }
+ /* Derive the timeout. Default to 1s. */
+ timeout_ms = 1000;
if (bits && baud) {
/* Throw in 10ms for misc OS overhead. */
timeout_ms = 10;
timeout_ms += ((1000.0 / baud) * bits) * num_bytes;
}
- sp_free_config(config);
-
return timeout_ms;
}
+#else
+
+/* TODO Put fallback.c content here? */
+
+#endif
+
/** @} */
projects / libsigrok.git / blobdiff