X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fstd.c;h=a03e509c732b4c0693ef6ee69638bffa9acc236a;hb=510aa8281f19b6312163ff2f09d6515661889378;hp=55952240fefe94e018e4a6b654477c0eab4b220f;hpb=6ec6c43b4738dbc7091f4a49a4ec80ea6102cb52;p=libsigrok.git

diff --git a/src/std.c b/src/std.c
index 55952240..a03e509c 100644
--- a/src/std.c
+++ b/src/std.c
@@ -39,22 +39,15 @@
  * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
  * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
  *
- * @param sr_ctx The libsigrok context to assign.
  * @param di The driver instance to use.
- * @param[in] prefix A driver-specific prefix string used for log messages.
+ * @param sr_ctx The libsigrok context to assign.
  *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
-		     const char *prefix)
+SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 {
 	struct drv_context *drvc;
 
-	if (!di) {
-		sr_err("%s: Invalid driver, cannot initialize.", prefix);
-		return SR_ERR_ARG;
-	}
-
 	drvc = g_malloc0(sizeof(struct drv_context));
 	drvc->sr_ctx = sr_ctx;
 	drvc->instances = NULL;
@@ -63,6 +56,28 @@ SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 	return SR_OK;
 }
 
+/**
+ * Standard driver cleanup() callback API helper
+ *
+ * @param di The driver instance to use.
+ *
+ * Frees all device instances by calling sr_dev_clear() and then releases any
+ * resources allocated by std_init().
+ *
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid driver
+ *
+*/
+SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
+{
+	int ret;
+
+	ret = sr_dev_clear(di);
+	g_free(di->context);
+
+	return ret;
+}
+
 /**
  * Standard API helper for sending an SR_DF_HEADER packet.
  *
@@ -105,6 +120,38 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 	return SR_OK;
 }
 
+/**
+ * Standard API helper for sending an SR_DF_END packet.
+ *
+ * @param sdi The device instance to use. Must not be NULL.
+ * @param prefix A driver-specific prefix string used for log messages.
+ * 		 Must not be NULL. An empty string is allowed.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
+ *         SR_ERR upon other errors.
+ */
+SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi,
+				    const char *prefix)
+{
+	int ret;
+	struct sr_datafeed_packet packet;
+
+	if (!sdi || !prefix)
+		return SR_ERR_ARG;
+
+	sr_dbg("%s: Sending SR_DF_END packet.", prefix);
+
+	packet.type = SR_DF_END;
+	packet.payload = NULL;
+
+	if ((ret = sr_session_send(sdi, &packet)) < 0) {
+		sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
+		return ret;
+	}
+
+	return SR_OK;
+}
+
 #ifdef HAVE_LIBSERIALPORT
 
 /**
@@ -179,11 +226,10 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
  * @retval SR_ERR Other errors.
  */
 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
-			void *cb_data, dev_close_callback dev_close_fn,
+			dev_close_callback dev_close_fn,
 			struct sr_serial_dev_inst *serial, const char *prefix)
 {
 	int ret;
-	struct sr_datafeed_packet packet;
 
 	if (!prefix) {
 		sr_err("Invalid prefix.");
@@ -207,14 +253,7 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 		return ret;
 	}
 
-	/* Send SR_DF_END packet to the session bus. */
-	sr_dbg("%s: Sending SR_DF_END packet.", prefix);
-	packet.type = SR_DF_END;
-	packet.payload = NULL;
-	if ((ret = sr_session_send(cb_data, &packet)) < 0) {
-		sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
-		return ret;
-	}
+	std_session_send_df_end(sdi, prefix);
 
 	return SR_OK;
 }
@@ -291,3 +330,22 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 
 	return ret;
 }
+
+/**
+ * Standard implementation for the driver dev_list() callback
+ *
+ * This function can be used as the dev_list callback by most drivers that use
+ * the standard helper functions. It returns the devices contained in the driver
+ * context instances list.
+ *
+ * @param di The driver instance to use.
+ *
+ * @return The list of devices/instances of this driver, or NULL upon errors
+ *         or if the list is empty.
+ */
+SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
+{
+	struct drv_context *drvc = di->context;
+
+	return drvc->instances;
+}