X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=std.c;h=8add0d3dc622c2045cfa5c870efb4ab39183dde7;hb=c2523f221364c0df51b8093693a246a713633912;hp=d436436cf6b77e03be31b4c0a5f8dc0298e2731c;hpb=4afdfd4628e9955af02a3ea619ecdfe469f9a9e2;p=libsigrok.git

diff --git a/std.c b/std.c
index d436436c..8add0d3d 100644
--- a/std.c
+++ b/std.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
  *
@@ -47,12 +47,13 @@ SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 		return SR_ERR_ARG;
 	}
 
-	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
+	if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
 		sr_err("%sDriver context malloc failed.", prefix);
 		return SR_ERR_MALLOC;
 	}
 
 	drvc->sr_ctx = sr_ctx;
+	drvc->instances = NULL;
 	di->priv = drvc;
 
 	return SR_OK;
@@ -99,3 +100,119 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 
 	return SR_OK;
 }
+
+/*
+ * Standard sr_session_stop() API helper.
+ *
+ * This function can be used to simplify most (serial port based) driver's
+ * hw_dev_acquisition_stop() API callback.
+ *
+ * @param sdi The device instance for which acquisition should stop.
+ *            Must not be NULL.
+ * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
+ * @param hw_dev_close_fn Function pointer to the driver's hw_dev_close().
+ *               	  Must not be NULL.
+ * @param serial The serial device instance (struct serial_dev_inst *).
+ *               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_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
+			void *cb_data, dev_close_t hw_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.");
+		return SR_ERR_ARG;
+	}
+
+	if (sdi->status != SR_ST_ACTIVE) {
+		sr_err("%sDevice inactive, can't stop acquisition.", prefix);
+		return SR_ERR;
+	}
+
+	sr_dbg("%sStopping acquisition.", prefix);
+
+	if ((ret = sr_source_remove(serial->fd)) < 0) {
+		sr_err("%sFailed to remove source: %d.", prefix, ret);
+		return ret;
+	}
+
+	if ((ret = hw_dev_close_fn(sdi)) < 0) {
+		sr_err("%sFailed to close device: %d.", prefix, ret);
+		return ret;
+	}
+
+	/* Send SR_DF_END packet to the session bus. */
+	sr_dbg("%sSending SR_DF_END packet.", prefix);
+	packet.type = SR_DF_END;
+	packet.payload = NULL;
+	if ((ret = sr_session_send(cb_data, &packet)) < 0) {
+		sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
+		return ret;
+	}
+
+	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,
+		std_dev_clear_t clear_private)
+{
+	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);
+		}
+		if (clear_private)
+			clear_private(sdi->priv);
+		sdi = l->data;
+		sr_dev_inst_free(sdi);
+	}
+
+	g_slist_free(drvc->instances);
+	drvc->instances = NULL;
+
+	return ret;
+}