]> sigrok.org Git - libsigrok.git/blobdiff - hardware/common/serial.c
Add blocking and nonblocking versions of serial_read and serial_write.
[libsigrok.git] / hardware / common / serial.c
index 891fd02d3729e43b235f8e1b404ed2642ee8482e..d08f22bdcd981c0a91f111fb777911d5ba3616c3 100644 (file)
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with subsystem-specific prefix string. */
-#define LOG_PREFIX "serial: "
-#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
-#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
-#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
-#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
-#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
-#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
+#define LOG_PREFIX "serial"
 
 /**
  * Open the specified serial port.
@@ -174,17 +167,8 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
        return SR_OK;
 }
 
-/**
- * Write a number of bytes to the specified serial port.
- *
- * @param serial Previously initialized serial port structure.
- * @param buf Buffer containing the bytes to write.
- * @param count Number of bytes to write.
- *
- * @return The number of bytes written, or a negative error code upon failure.
- */
-SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
-               const void *buf, size_t count)
+static int _serial_write(struct sr_serial_dev_inst *serial,
+               const void *buf, size_t count, int nonblocking)
 {
        ssize_t ret;
        char *error;
@@ -199,7 +183,7 @@ SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
                return SR_ERR;
        }
 
-       if (serial->nonblocking)
+       if (nonblocking)
                ret = sp_nonblocking_write(serial->data, buf, count);
        else
                ret = sp_blocking_write(serial->data, buf, count, 0);
@@ -221,16 +205,34 @@ SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 }
 
 /**
- * Read a number of bytes from the specified serial port.
+ * Write a number of bytes to the specified serial port.
  *
  * @param serial Previously initialized serial port structure.
- * @param buf Buffer where to store the bytes that are read.
- * @param count The number of bytes to read.
+ * @param buf Buffer containing the bytes to write.
+ * @param count Number of bytes to write.
  *
- * @return The number of bytes read, or a negative error code upon failure.
+ * @return The number of bytes written, or a negative error code upon failure.
  */
-SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
-               size_t count)
+SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
+               const void *buf, size_t count)
+{
+       return _serial_write(serial, buf, count, serial->nonblocking);
+}
+
+SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
+               const void *buf, size_t count)
+{
+       return _serial_write(serial, buf, count, 0);
+}
+
+SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
+               const void *buf, size_t count)
+{
+       return _serial_write(serial, buf, count, 1);
+}
+
+static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
+               size_t count, int nonblocking)
 {
        ssize_t ret;
        char *error;
@@ -245,7 +247,7 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
                return SR_ERR;
        }
 
-       if (serial->nonblocking)
+       if (nonblocking)
                ret = sp_nonblocking_read(serial->data, buf, count);
        else
                ret = sp_blocking_read(serial->data, buf, count, 0);
@@ -267,6 +269,33 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
        return ret;
 }
 
+/**
+ * Read a number of bytes from the specified serial port.
+ *
+ * @param serial Previously initialized serial port structure.
+ * @param buf Buffer where to store the bytes that are read.
+ * @param count The number of bytes to read.
+ *
+ * @return The number of bytes read, or a negative error code upon failure.
+ */
+SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
+               size_t count)
+{
+       return _serial_read(serial, buf, count, serial->nonblocking);
+}
+
+SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
+               size_t count)
+{
+       return _serial_read(serial, buf, count, 0);
+}
+
+SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
+               size_t count)
+{
+       return _serial_read(serial, buf, count, 1);
+}
+
 /**
  * Set serial parameters for the specified serial port.
  *