std: Add std_session_send_df_trigger().

[libsigrok.git] / src / std.c

diff --git a/src/std.c b/src/std.c
index 581e2e467440f7776dc508e5a7d702691062ab92..ff09f46fc5eac5e11d9b54abe22f318c37c29e34 100644 (file)
--- 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.
  *