From: Bert Vermeulen <redacted>
Date: Tue, 16 Apr 2013 15:53:21 +0000 (+0200)
Subject: Add driver helper std_dev_clear()
X-Git-Tag: dsupstream~125
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=49f00e13f72d11a9cac8523e0c1506dde138f218;p=libsigrok.git

Add driver helper std_dev_clear()
---

diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index bd1b7289..9d0cec32 100644
--- a/libsigrok-internal.h
+++ b/libsigrok-internal.h
@@ -136,6 +136,7 @@ SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 			struct sr_serial_dev_inst *serial, const char *prefix);
 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 				       const char *prefix);
+SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
 
 /*--- hardware/common/serial.c ----------------------------------------------*/
 
diff --git a/std.c b/std.c
index 5eb2e57d..f3519a1d 100644
--- a/std.c
+++ b/std.c
@@ -159,3 +159,56 @@ SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 
 	return SR_OK;
 }
+
+/*
+ * Standard driver dev_clear() helper.
+ *
+ * This function can be used to implement the dev_clear() driver API
+ * callback. dev_close() is called before every sr_dev_inst is cleared.
+ *
+ * The only limitation is driver-specific device contexts (sdi->priv).
+ * These are freed, but any dynamic allocation within structs stored
+ * there cannot be freed.
+ *
+ * @param driver The driver which will have its instances released.
+ *
+ * @return SR_OK on success.
+ */
+SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver)
+{
+	struct sr_dev_inst *sdi;
+	struct drv_context *drvc;
+	struct dev_context *devc;
+	GSList *l;
+	int ret;
+
+	drvc = driver->priv;
+	ret = SR_OK;
+	for (l = drvc->instances; l; l = l->next) {
+		/* Log errors, but continue cleaning up the rest. */
+		if (!(sdi = l->data)) {
+			ret = SR_ERR_BUG;
+			continue;
+		}
+		if (!(devc = sdi->priv)) {
+			ret = SR_ERR_BUG;
+			continue;
+		}
+		if (driver->dev_close)
+			driver->dev_close(sdi);
+
+		if (sdi->conn) {
+			if (sdi->inst_type == SR_INST_USB)
+				sr_usb_dev_inst_free(sdi->conn);
+			else if (sdi->inst_type == SR_INST_SERIAL)
+				sr_serial_dev_inst_free(sdi->conn);
+		}
+		sdi = l->data;
+		sr_dev_inst_free(sdi);
+	}
+
+	g_slist_free(drvc->instances);
+	drvc->instances = NULL;
+
+	return ret;
+}