From: Uwe Hermann <redacted>
Date: Wed, 8 Apr 2020 21:02:04 +0000 (+0200)
Subject: std: Add std_session_send_df_trigger().
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=10cf8113858f017687ce792f7c370db38023914e;p=libsigrok.git

std: Add std_session_send_df_trigger().
---

diff --git a/src/libsigrok-internal.h b/src/libsigrok-internal.h
index 140d11e1..94ac3d1a 100644
--- a/src/libsigrok-internal.h
+++ b/src/libsigrok-internal.h
@@ -1030,6 +1030,7 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
 #endif
 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
+SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi);
 SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi);
 SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi);
 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
diff --git a/src/std.c b/src/std.c
index 581e2e46..ff09f46f 100644
--- a/src/std.c
+++ b/src/std.c
@@ -231,6 +231,41 @@ SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
 	return SR_OK;
 }
 
+/**
+ * Standard API helper for sending an SR_DF_TRIGGER packet.
+ *
+ * This function can be used to simplify most drivers' trigger handling.
+ *
+ * @param[in] sdi The device instance to use. Must not be NULL.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
+ */
+SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi)
+{
+	const char *prefix;
+	int ret;
+	struct sr_datafeed_packet packet;
+
+	if (!sdi) {
+		sr_err("%s: Invalid argument.", __func__);
+		return SR_ERR_ARG;
+	}
+
+	prefix = (sdi->driver) ? sdi->driver->name : "unknown";
+
+	packet.type = SR_DF_TRIGGER;
+	packet.payload = NULL;
+
+	if ((ret = sr_session_send(sdi, &packet)) < 0) {
+		sr_err("%s: Failed to send SR_DF_TRIGGER packet: %d.", prefix, ret);
+		return ret;
+	}
+
+	return SR_OK;
+}
+
 /**
  * Standard API helper for sending an SR_DF_FRAME_BEGIN packet.
  *