Add sr_dev_acquisition_start(), factor out SR_ERR_DEV_CLOSED check.

[libsigrok.git] / src / hwdriver.c

diff --git a/src/hwdriver.c b/src/hwdriver.c
index c23e761a143bafad6fa611b667ba4fbb9863ca37..b16dcd34f6f28af0ed8317397f483a74d84eacdb 100644 (file)
--- a/src/hwdriver.c
+++ b/src/hwdriver.c
@@ -61,6 +61,7 @@ static struct sr_key_info sr_key_info_config[] = {
        {SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", NULL},
        {SR_CONF_ELECTRONIC_LOAD, SR_T_STRING, NULL, "Electronic load", NULL},
        {SR_CONF_SCALE, SR_T_STRING, NULL, "Scale", NULL},
+       {SR_CONF_SIGNAL_GENERATOR, SR_T_STRING, NULL, "Signal generator", NULL},
 
        /* Driver scan options */
        {SR_CONF_CONN, SR_T_STRING, "conn",
@@ -247,6 +248,7 @@ static struct sr_key_info sr_key_info_mq[] = {
        {SR_MQ_POWER_FACTOR, 0, "power_factor", "Power factor", NULL},
        {SR_MQ_APPARENT_POWER, 0, "apparent_power", "Apparent power", NULL},
        {SR_MQ_MASS, 0, "mass", "Mass", NULL},
+       {SR_MQ_HARMONIC_RATIO, 0, "harmonic_ratio", "Harmonic ratio", NULL},
        ALL_ZERO
 };
 
@@ -285,6 +287,7 @@ static struct sr_key_info sr_key_info_mqflag[] = {
 };
 
 /* This must handle all the keys from enum sr_datatype (libsigrok.h). */
+/** @private */
 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
 {
        switch (datatype) {
@@ -312,6 +315,7 @@ SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
        }
 }
 
+/** @private */
 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
 {
        const struct sr_key_info *info;
@@ -390,7 +394,6 @@ SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
                return SR_ERR_ARG;
        }
 
-       sr_spew("Initializing driver '%s'.", driver->name);
        if ((ret = driver->init(driver, ctx)) < 0)
                sr_err("Failed to initialize the driver: %d.", ret);
 
@@ -553,9 +556,12 @@ SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
        }
 }
 
-/** Allocate struct sr_config.
- *  A floating reference can be passed in for data.
- *  @private
+/**
+ * Allocate struct sr_config.
+ *
+ * A floating reference can be passed in for data.
+ *
+ * @private
  */
 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
 {
@@ -568,8 +574,10 @@ SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
        return src;
 }
 
-/** Free struct sr_config.
- *  @private
+/**
+ * Free struct sr_config.
+ *
+ * @private
  */
 SR_PRIV void sr_config_free(struct sr_config *src)
 {
@@ -584,6 +592,44 @@ SR_PRIV void sr_config_free(struct sr_config *src)
 
 }
 
+/** @private */
+SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi)
+{
+       if (!sdi || !sdi->driver) {
+               sr_err("%s: Invalid arguments.", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (sdi->status != SR_ST_ACTIVE) {
+               sr_err("%s: Device instance not active, can't start.",
+                       sdi->driver->name);
+               return SR_ERR_DEV_CLOSED;
+       }
+
+       sr_dbg("%s: Starting acquisition.", sdi->driver->name);
+
+       return sdi->driver->dev_acquisition_start(sdi);
+}
+
+/** @private */
+SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi)
+{
+       if (!sdi || !sdi->driver) {
+               sr_err("%s: Invalid arguments.", __func__);
+               return SR_ERR_ARG;
+       }
+
+       if (sdi->status != SR_ST_ACTIVE) {
+               sr_err("%s: Device instance not active, can't stop.",
+                       sdi->driver->name);
+               return SR_ERR_DEV_CLOSED;
+       }
+
+       sr_dbg("%s: Stopping acquisition.", sdi->driver->name);
+
+       return sdi->driver->dev_acquisition_stop(sdi);
+}
+
 static void log_key(const struct sr_dev_inst *sdi,
        const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
 {
@@ -680,7 +726,7 @@ static int check_key(const struct sr_dev_driver *driver,
  *            Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
  *            also be != NULL.
  * @param[in] cg The channel group on the device for which to list the
- *                    values, or NULL.
+ *               values, or NULL.
  * @param[in] key The configuration key (SR_CONF_*).
  * @param[in,out] data Pointer to a GVariant where the value will be stored.
  *             Must not be NULL. The caller is given ownership of the GVariant
@@ -691,8 +737,8 @@ static int check_key(const struct sr_dev_driver *driver,
  * @retval SR_OK Success.
  * @retval SR_ERR Error.
  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
- *          interpreted as an error by the caller; merely as an indication
- *          that it's not applicable.
+ *         interpreted as an error by the caller; merely as an indication
+ *         that it's not applicable.
  *
  * @since 0.3.0
  */
@@ -742,8 +788,8 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver,
  * @retval SR_OK Success.
  * @retval SR_ERR Error.
  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
- *          interpreted as an error by the caller; merely as an indication
- *          that it's not applicable.
+ *         interpreted as an error by the caller; merely as an indication
+ *         that it's not applicable.
  *
  * @since 0.3.0
  */
@@ -814,8 +860,8 @@ SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
  * @retval SR_OK Success.
  * @retval SR_ERR Error.
  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
- *          interpreted as an error by the caller; merely as an indication
- *          that it's not applicable.
+ *         interpreted as an error by the caller; merely as an indication
+ *         that it's not applicable.
  *
  * @since 0.3.0
  */