X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=std.c;h=5eb2e57d8e9808f19c1e13588484f92ead7592d4;hb=8e34ca86fb54ec1c841724900006868e29b180fa;hp=a9cbec0eaa367134b85b56572e7ba0b755a711cf;hpb=063e7aef6d41d4c44591ff93672079998bf9622f;p=libsigrok.git

diff --git a/std.c b/std.c
index a9cbec0e..5eb2e57d 100644
--- a/std.c
+++ b/std.c
@@ -57,3 +57,105 @@ SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 
 	return SR_OK;
 }
+
+/**
+ * Standard API helper for sending an SR_DF_HEADER packet.
+ *
+ * This function can be used to simplify most driver's
+ * hw_dev_acquisition_start() API callback.
+ *
+ * @param sdi The device instance to use.
+ * @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_header(const struct sr_dev_inst *sdi,
+				       const char *prefix)
+{
+	int ret;
+	struct sr_datafeed_packet packet;
+	struct sr_datafeed_header header;
+
+	if (!prefix) {
+		sr_err("Invalid prefix.");
+		return SR_ERR_ARG;
+	}
+
+	sr_dbg("%sStarting acquisition.", prefix);
+
+	/* Send header packet to the session bus. */
+	sr_dbg("%sSending SR_DF_HEADER packet.", prefix);
+	packet.type = SR_DF_HEADER;
+	packet.payload = (uint8_t *)&header;
+	header.feed_version = 1;
+	gettimeofday(&header.starttime, NULL);
+
+	if ((ret = sr_session_send(sdi, &packet)) < 0) {
+		sr_err("%sFailed to send header packet: %d.", prefix, ret);
+		return ret;
+	}
+
+	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;
+}