]> sigrok.org Git - libsigrok.git/blobdiff - src/serial.c
ols: Fix serial port timeout.
[libsigrok.git] / src / serial.c
index 83df6a348064ed1b3292c0c1180b06383721b7f9..37463573256f26c0c750d789ac931566968ecd69 100644 (file)
@@ -34,7 +34,7 @@
  *
  * @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, SERIAL_NONBLOCK.
+ *              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.
@@ -62,8 +62,6 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
        else if (flags & SERIAL_RDONLY)
                sp_flags = SP_MODE_READ;
 
-       serial->nonblocking = (flags & SERIAL_NONBLOCK) ? 1 : 0;
-
        ret = sp_open(serial->data, sp_flags);
 
        switch (ret) {
@@ -172,7 +170,7 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 }
 
 static int _serial_write(struct sr_serial_dev_inst *serial,
-               const void *buf, size_t count, int nonblocking)
+               const void *buf, size_t count, int nonblocking, unsigned int timeout_ms)
 {
        ssize_t ret;
        char *error;
@@ -190,7 +188,7 @@ static int _serial_write(struct sr_serial_dev_inst *serial,
        if (nonblocking)
                ret = sp_nonblocking_write(serial->data, buf, count);
        else
-               ret = sp_blocking_write(serial->data, buf, count, 0);
+               ret = sp_blocking_write(serial->data, buf, count, timeout_ms);
 
        switch (ret) {
        case SP_ERR_ARG:
@@ -209,44 +207,43 @@ static int _serial_write(struct sr_serial_dev_inst *serial,
 }
 
 /**
- * Write a number of bytes to the specified serial port.
+ * Write a number of bytes to the specified serial port, blocking until finished.
  *
  * @param serial Previously initialized serial port structure.
  * @param[in] buf Buffer containing the bytes to write.
  * @param[in] count Number of bytes to write.
+ * @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 written.
- */
-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);
-}
-
-/**
- * Write a number of bytes to the specified serial port, blocking until finished.
- * @copydetails serial_write()
+ * @retval other The number of bytes written. If this is less than the number
+ * specified in the call, the timeout was reached.
  */
 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
-               const void *buf, size_t count)
+               const void *buf, size_t count, unsigned int timeout_ms)
 {
-       return _serial_write(serial, buf, count, 0);
+       return _serial_write(serial, buf, count, 0, timeout_ms);
 }
 
 /**
  * Write a number of bytes to the specified serial port, return immediately.
- * @copydetails serial_write()
+ *
+ * @param serial Previously initialized serial port structure.
+ * @param[in] buf Buffer containing the bytes to write.
+ * @param[in] count Number of bytes to write.
+ *
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval SR_ERR Other error.
+ * @retval other The number of bytes written.
 */
 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);
+       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)
+               size_t count, int nonblocking, unsigned int timeout_ms)
 {
        ssize_t ret;
        char *error;
@@ -264,7 +261,7 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
        if (nonblocking)
                ret = sp_nonblocking_read(serial->data, buf, count);
        else
-               ret = sp_blocking_read(serial->data, buf, count, 0);
+               ret = sp_blocking_read(serial->data, buf, count, timeout_ms);
 
        switch (ret) {
        case SP_ERR_ARG:
@@ -284,41 +281,40 @@ static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
 }
 
 /**
- * Read a number of bytes from the specified serial port.
+ * Read a number of bytes from the specified serial port, block until finished.
  *
  * @param serial Previously initialized serial port structure.
  * @param buf Buffer where to store the bytes that are read.
  * @param[in] count The number of bytes to read.
+ * @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.
- */
-SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
-               size_t count)
-{
-       return _serial_read(serial, buf, count, serial->nonblocking);
-}
-
-/**
- * Read a number of bytes from the specified serial port, block until finished.
- * @copydetails serial_read()
+ * @retval other      The number of bytes read. If this is less than the number
+ * requested, the timeout was reached.
  */
 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
-               size_t count)
+               size_t count, unsigned int timeout_ms)
 {
-       return _serial_read(serial, buf, count, 0);
+       return _serial_read(serial, buf, count, 0, timeout_ms);
 }
 
 /**
  * Try to read up to @a count bytes from the specified serial port, return
  * immediately with what's available.
- * @copydetails serial_read()
+ *
+ * @param serial Previously initialized serial port structure.
+ * @param buf Buffer where to store the bytes that are read.
+ * @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.
  */
 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
                size_t count)
 {
-       return _serial_read(serial, buf, count, 1);
+       return _serial_read(serial, buf, count, 1, 0);
 }
 
 /**
@@ -802,3 +798,43 @@ SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
        sp_free_port_list(ports);
        return tty_devs;
 }
+
+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;
+
+       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 (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;
+}