* 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 a (assumed opened) serial port is of any supported type. */
+static int dev_is_supported(struct sr_serial_dev_inst *serial)
+{
+ if (!serial)
+ return 0;
+ if (!serial->lib_funcs)
+ return 0;
+
+ return 1;
+}
+
/**
* Open the specified serial port.
*
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;
*/
SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
{
+ int rc;
+
if (!serial) {
sr_dbg("Invalid serial port.");
return SR_ERR;
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;
}
/**
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);
}
/**
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.
+ */
+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.
+ *
+ * @internal
+ */
+SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial)
+{
+ if (!serial)
+ return;
+ if (!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.
+ *
+ * @internal
+ */
+SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial)
+{
+ if (!serial)
+ return 0;
+ if (!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.
+ *
+ * @internal
+ */
+SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
+ const uint8_t *data, size_t len)
+{
+ if (!serial)
+ return;
+ if (!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.
+ *
+ * @internal
+ */
+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)
+ return 0;
+ if (!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.
+ */
+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,
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;
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);
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;
return SR_ERR;
}
- if (!serial->sp_data) {
+ if (!dev_is_supported(serial)) {
sr_dbg("Cannot use unopened serial port %s.", serial->port);
return -1;
}
* @param is_valid Callback that assesses whether the packet is valid or not.
* @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.
*
* @retval SR_OK Valid packet was found within the given timeout.
* @retval SR_ERR Failure.
uint8_t *buf, size_t *buflen,
size_t packet_size,
packet_valid_callback is_valid,
- uint64_t timeout_ms, int baudrate)
+ uint64_t timeout_ms)
{
uint64_t start, time, byte_delay_us;
size_t ibuf, i, maxlen;
maxlen = *buflen;
- sr_dbg("Detecting packets on %s (timeout = %" PRIu64
- "ms, baudrate = %d).", serial->port, timeout_ms, baudrate);
+ sr_dbg("Detecting packets on %s (timeout = %" PRIu64 "ms).",
+ serial->port, timeout_ms);
- if (maxlen < (packet_size / 2) ) {
+ 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 * ((1000 * 1000) / baudrate);
+ byte_delay_us = serial_timeout(serial, 1) * 1000;
start = g_get_monotonic_time();
i = ibuf = len = 0;
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);
}
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);
}
/**
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;
}
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;
}
/* 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 +
return timeout_ms;
}
+#else
+
+/* TODO Put fallback.c content here? */
+
+#endif
+
/** @} */
projects / libsigrok.git / blobdiff