X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fserial.c;h=ef1563829eb13d54cd8492fbc853fa1415a1ec8e;hb=8c3df6e5cd3d23bf01807e6296f7b7a9f8475902;hp=fc7063882a259d6a1fe381ab3a20d60d69bb5a97;hpb=b1a7ca3b605a8a7e7ce97dfc9eb211e9b3a5c918;p=libsigrok.git
diff --git a/src/serial.c b/src/serial.c
index fc706388..ef156382 100644
--- a/src/serial.c
+++ b/src/serial.c
@@ -20,34 +20,54 @@
* along with this program. If not, see .
*/
+#include
#include
#include
#include
#include
#include
-#include "libsigrok.h"
+#include
#include "libsigrok-internal.h"
+#ifdef _WIN32
+#include /* for HANDLE */
+#endif
+/** @cond PRIVATE */
#define LOG_PREFIX "serial"
+/** @endcond */
+
+/**
+ * @file
+ *
+ * Serial port handling.
+ */
+
+/**
+ * @defgroup grp_serial Serial port handling
+ *
+ * Serial port handling functions.
+ *
+ * @{
+ */
/**
* Open the specified serial port.
*
* @param serial Previously initialized serial port structure.
* @param[in] flags Flags to use when opening the serial port. Possible flags
- * include SERIAL_RDWR, SERIAL_RDONLY.
+ * include SERIAL_RDWR, SERIAL_RDONLY.
*
* If the serial structure contains a serialcomm string, it will be
* passed to serial_set_paramstr() after the port is opened.
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
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.");
@@ -56,26 +76,9 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
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;
-
- 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 (%d): %s.",
- sp_last_error_code(), error);
- sp_free_error_message(error);
- return SR_ERR;
- }
+ ret = sr_ser_libsp_open(serial, flags);
+ if (ret != SR_OK)
+ return ret;
if (serial->serialcomm)
return serial_set_paramstr(serial, serial->serialcomm);
@@ -90,157 +93,93 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_close(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 close unopened serial port %s.", serial->port);
- return SR_ERR;
- }
-
sr_spew("Closing serial port %s.", serial->port);
- ret = sp_close(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 (%d): %s.",
- sp_last_error_code(), error);
- sp_free_error_message(error);
- return SR_ERR;
- }
-
- sp_free_port(serial->data);
- serial->data = NULL;
-
- return SR_OK;
+ return sr_ser_libsp_close(serial);
}
/**
- * Flush serial port buffers.
+ * Flush serial port buffers. Empty buffers, discard pending RX and TX data.
*
* @param serial Previously initialized serial port structure.
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
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);
-
- 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;
- }
-
- return SR_OK;
+ return sr_ser_libsp_flush(serial);
}
/**
- * Drain serial port buffers.
+ * Drain serial port buffers. Wait for pending TX data to be sent.
*
* @param serial Previously initialized serial port structure.
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
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 (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 sr_ser_libsp_drain(serial);
+}
- return SR_OK;
+/**
+ * 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)
+{
+ return sr_ser_libsp_get_rx_avail(serial);
}
static int _serial_write(struct sr_serial_dev_inst *serial,
- const void *buf, size_t count, int nonblocking, unsigned int timeout_ms)
+ const 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_write(serial->data, buf, count);
- else
- ret = sp_blocking_write(serial->data, buf, count, timeout_ms);
-
- 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);
- return SR_ERR;
- }
-
- sr_spew("Wrote %d/%d bytes.", ret, count);
+ ret = sr_ser_libsp_write(serial, buf, count, nonblocking, timeout_ms);
+ sr_spew("Wrote %zd/%zu bytes.", ret, count);
return ret;
}
@@ -257,9 +196,11 @@ static int _serial_write(struct sr_serial_dev_inst *serial,
* @retval SR_ERR Other error.
* @retval other The number of bytes written. If this is less than the number
* specified in the call, the timeout was reached.
+ *
+ * @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);
}
@@ -274,47 +215,28 @@ SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
* @retval SR_ERR_ARG Invalid argument.
* @retval SR_ERR Other error.
* @retval other The number of bytes written.
-*/
+ *
+ * @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;
- }
-
+ ret = sr_ser_libsp_read(serial, buf, count, nonblocking, timeout_ms);
if (ret > 0)
- sr_spew("Read %d/%d bytes.", ret, count);
+ sr_spew("Read %zd/%zu bytes.", ret, count);
return ret;
}
@@ -328,12 +250,14 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
* @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
*
* @retval SR_ERR_ARG Invalid argument.
- * @retval SR_ERR Other error.
- * @retval other The number of bytes read. If this is less than the number
+ * @retval SR_ERR Other error.
+ * @retval other The number of bytes read. If this is less than the number
* requested, the timeout was reached.
+ *
+ * @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);
}
@@ -347,11 +271,13 @@ SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
* @param[in] count The number of bytes to read.
*
* @retval SR_ERR_ARG Invalid argument.
- * @retval SR_ERR Other error.
- * @retval other The number of bytes read.
+ * @retval SR_ERR Other error.
+ * @retval other The number of bytes read.
+ *
+ * @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);
}
@@ -365,72 +291,42 @@ SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf
* @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd).
* @param[in] stopbits The number of stop bits to use (1 or 2).
* @param[in] flowcontrol The flow control settings to use (0 = none,
- * 1 = RTS/CTS, 2 = XON/XOFF).
+ * 1 = RTS/CTS, 2 = XON/XOFF).
* @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
* @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @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;
- }
- 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 SR_ERR;
+ ret = sr_ser_libsp_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);
}
- return SR_OK;
+ return ret;
}
/**
@@ -439,7 +335,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
* @param serial Previously initialized serial port structure.
* @param[in] paramstr A serial communication parameters string of the form
* "/{/