sr_dev_close(): Set status to SR_ST_INACTIVE.

[libsigrok.git] / src / device.c

diff --git a/src/device.c b/src/device.c
index e5cbf4ef2868473e1c689e0752361d5f9e35c998..9ba8bfc570cb43ed9bec54a661904b45ec6f7e88 100644 (file)
--- a/src/device.c
+++ b/src/device.c
@@ -545,11 +545,19 @@ SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
 }
 
 /**
- * Open the specified device.
+ * Open the specified device instance.
+ *
+ * If the device instance is already open (sdi->status == SR_ST_ACTIVE),
+ * SR_ERR will be returned and no re-opening of the device will be attempted.
+ *
+ * If opening was successful, sdi->status is set to SR_ST_ACTIVE, otherwise
+ * it will be left unchanged.
  *
  * @param sdi Device instance to use. Must not be NULL.
  *
- * @return SR_OK upon success, a negative error code upon errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid arguments.
+ * @retval SR_ERR Device instance was already active, or other error.
  *
  * @since 0.2.0
  */
@@ -558,7 +566,7 @@ SR_API int sr_dev_open(struct sr_dev_inst *sdi)
        int ret;
 
        if (!sdi || !sdi->driver || !sdi->driver->dev_open)
-               return SR_ERR;
+               return SR_ERR_ARG;
 
        if (sdi->status == SR_ST_ACTIVE) {
                sr_err("%s: Device instance already active, can't re-open.",
@@ -566,19 +574,32 @@ SR_API int sr_dev_open(struct sr_dev_inst *sdi)
                return SR_ERR;
        }
 
-       sr_dbg("%s: Opening device.", sdi->driver->name)
+       sr_dbg("%s: Opening device instance.", sdi->driver->name);
 
        ret = sdi->driver->dev_open(sdi);
 
+       if (ret == SR_OK)
+               sdi->status = SR_ST_ACTIVE;
+
        return ret;
 }
 
 /**
- * Close the specified device.
+ * Close the specified device instance.
+ *
+ * If the device instance is not open (sdi->status != SR_ST_ACTIVE),
+ * SR_ERR_DEV_CLOSED will be returned and no closing will be attempted.
+ *
+ * Note: sdi->status will be set to SR_ST_INACTIVE, regardless of whether
+ * there are any errors during closing of the device instance (any errors
+ * will be reported via error code and log message, though).
  *
  * @param sdi Device instance to use. Must not be NULL.
  *
- * @return SR_OK upon success, a negative error code upon errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid arguments.
+ * @retval SR_ERR_DEV_CLOSED Device instance was not active.
+ * @retval SR_ERR Other error.
  *
  * @since 0.2.0
  */
@@ -587,7 +608,7 @@ SR_API int sr_dev_close(struct sr_dev_inst *sdi)
        int ret;
 
        if (!sdi || !sdi->driver || !sdi->driver->dev_close)
-               return SR_ERR;
+               return SR_ERR_ARG;
 
        if (sdi->status != SR_ST_ACTIVE) {
                sr_err("%s: Device instance not active, can't close.",
@@ -595,7 +616,9 @@ SR_API int sr_dev_close(struct sr_dev_inst *sdi)
                return SR_ERR_DEV_CLOSED;
        }
 
-       sr_dbg("%s: Closing device.", sdi->driver->name)
+       sdi->status = SR_ST_INACTIVE;
+
+       sr_dbg("%s: Closing device instance.", sdi->driver->name);
 
        ret = sdi->driver->dev_close(sdi);