]> sigrok.org Git - libsigrok.git/blobdiff - src/hwdriver.c
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / hwdriver.c
index 6758f6a96fc07c1f905d0708a00710b2481787b8..068a215ac5f6956a4968e46566d2c3e7ce11b9d7 100644 (file)
@@ -61,6 +61,9 @@ 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},
+       {SR_CONF_POWERMETER, SR_T_STRING, NULL, "Power meter", NULL},
+       {SR_CONF_MULTIPLEXER, SR_T_STRING, NULL, "Multiplexer", NULL},
 
        /* Driver scan options */
        {SR_CONF_CONN, SR_T_STRING, "conn",
@@ -69,6 +72,10 @@ static struct sr_key_info sr_key_info_config[] = {
                "Serial communication", NULL},
        {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr",
                "Modbus slave address", NULL},
+       {SR_CONF_FORCE_DETECT, SR_T_STRING, "force_detect",
+               "Forced detection", NULL},
+       {SR_CONF_PROBE_NAMES, SR_T_STRING, "probe_names",
+               "Names of device's probes", NULL},
 
        /* Device (or channel group) configuration */
        {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
@@ -175,6 +182,40 @@ static struct sr_key_info sr_key_info_config[] = {
                "Under-voltage condition", NULL},
        {SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE, SR_T_BOOL, "uvc_active",
                "Under-voltage condition active", NULL},
+       {SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD, SR_T_FLOAT, "uvc_threshold",
+               "Under-voltage condition threshold", NULL},
+       {SR_CONF_TRIGGER_LEVEL, SR_T_FLOAT, "triggerlevel",
+               "Trigger level", NULL},
+       {SR_CONF_EXTERNAL_CLOCK_SOURCE, SR_T_STRING, "external_clock_source",
+               "External clock source", NULL},
+       {SR_CONF_OFFSET, SR_T_FLOAT, "offset",
+               "Offset", NULL},
+       {SR_CONF_TRIGGER_PATTERN, SR_T_STRING, "triggerpattern",
+               "Trigger pattern", NULL},
+       {SR_CONF_HIGH_RESOLUTION, SR_T_BOOL, "highresolution",
+               "High resolution", NULL},
+       {SR_CONF_PEAK_DETECTION, SR_T_BOOL, "peakdetection",
+               "Peak detection", NULL},
+       {SR_CONF_LOGIC_THRESHOLD, SR_T_STRING, "logic_threshold",
+               "Logic threshold (predefined)", NULL},
+       {SR_CONF_LOGIC_THRESHOLD_CUSTOM, SR_T_FLOAT, "logic_threshold_custom",
+               "Logic threshold (custom)", NULL},
+       {SR_CONF_RANGE, SR_T_STRING, "range",
+               "Range", NULL},
+       {SR_CONF_DIGITS, SR_T_STRING, "digits",
+               "Digits", NULL},
+       {SR_CONF_PHASE, SR_T_FLOAT, "phase",
+               "Phase", NULL},
+       {SR_CONF_DUTY_CYCLE, SR_T_FLOAT, "output_duty_cycle",
+               "Duty Cycle", NULL},
+       {SR_CONF_POWER, SR_T_FLOAT, "power",
+               "Power", NULL},
+       {SR_CONF_POWER_TARGET, SR_T_FLOAT, "power_target",
+               "Power Target", NULL},
+       {SR_CONF_RESISTANCE_TARGET, SR_T_FLOAT, "resistance_target",
+               "Resistance Target", NULL},
+       {SR_CONF_OVER_CURRENT_PROTECTION_DELAY, SR_T_FLOAT, "ocp_delay",
+               "Over-current protection delay", NULL},
 
        /* Special stuff */
        {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
@@ -245,6 +286,9 @@ 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},
+       {SR_MQ_ENERGY, 0, "energy", "Energy", NULL},
+       {SR_MQ_ELECTRIC_CHARGE, 0, "electric_charge", "Electric charge", NULL},
        ALL_ZERO
 };
 
@@ -283,11 +327,14 @@ 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) {
        case SR_T_INT32:
                return G_VARIANT_TYPE_INT32;
+       case SR_T_UINT32:
+               return G_VARIANT_TYPE_UINT32;
        case SR_T_UINT64:
                return G_VARIANT_TYPE_UINT64;
        case SR_T_STRING:
@@ -310,6 +357,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;
@@ -388,7 +436,8 @@ 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);
+       /* No log message here, too verbose and not very useful. */
+
        if ((ret = driver->init(driver, ctx)) < 0)
                sr_err("Failed to initialize the driver: %d.", ret);
 
@@ -522,8 +571,7 @@ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 
        l = driver->scan(driver, options);
 
-       sr_spew("Scan of '%s' found %d devices.", driver->name,
-               g_slist_length(l));
+       sr_spew("Scan found %d devices (%s).", g_slist_length(l), driver->name);
 
        return l;
 }
@@ -543,6 +591,8 @@ SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
        if (!ctx)
                return;
 
+       sr_dbg("Cleaning up all drivers.");
+
        drivers = sr_driver_list(ctx);
        for (i = 0; drivers[i]; i++) {
                if (drivers[i]->cleanup)
@@ -551,9 +601,18 @@ 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.
+ *
+ * @param key The config key to use.
+ * @param data The GVariant data to use.
+ *
+ * @return The newly allocated struct sr_config. This function is assumed
+ *         to never fail.
+ *
+ * @private
  */
 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
 {
@@ -566,12 +625,13 @@ 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)
 {
-
        if (!src || !src->data) {
                sr_err("%s: invalid data!", __func__);
                return;
@@ -579,11 +639,49 @@ SR_PRIV void sr_config_free(struct sr_config *src)
 
        g_variant_unref(src->data);
        g_free(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)
+       const struct sr_channel_group *cg, uint32_t key, unsigned int op,
+       GVariant *data)
 {
        const char *opstr;
        const struct sr_key_info *srci;
@@ -605,7 +703,7 @@ static void log_key(const struct sr_dev_inst *sdi,
 
 static int check_key(const struct sr_dev_driver *driver,
                const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
-               uint32_t key, int op, GVariant *data)
+               uint32_t key, unsigned int op, GVariant *data)
 {
        const struct sr_key_info *srci;
        gsize num_opts, i;
@@ -616,9 +714,9 @@ static int check_key(const struct sr_dev_driver *driver,
        const char *opstr;
 
        if (sdi && cg)
-               suffix = " for this device and channel group";
+               suffix = " for this device instance and channel group";
        else if (sdi)
-               suffix = " for this device";
+               suffix = " for this device instance";
        else
                suffix = "";
 
@@ -640,6 +738,15 @@ static int check_key(const struct sr_dev_driver *driver,
                        return SR_ERR_ARG;
                }
                break;
+       case SR_CONF_CAPTURE_RATIO:
+               /* Capture ratio must always be between 0 and 100. */
+               if (op != SR_CONF_SET || !data)
+                       break;
+               if (g_variant_get_uint64(data) > 100) {
+                       sr_err("Capture ratio must be 0..100.");
+                       return SR_ERR_ARG;
+               }
+               break;
        }
 
        if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
@@ -678,7 +785,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
@@ -689,8 +796,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
  */
@@ -722,6 +829,10 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver,
                g_variant_ref_sink(*data);
        }
 
+       if (ret == SR_ERR_CHANNEL_GROUP)
+               sr_err("%s: No channel group specified.",
+                       (sdi) ? sdi->driver->name : "unknown");
+
        return ret;
 }
 
@@ -740,8 +851,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
  */
@@ -757,7 +868,11 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi,
                ret = SR_ERR;
        else if (!sdi->driver->config_set)
                ret = SR_ERR_ARG;
-       else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
+       else if (sdi->status != SR_ST_ACTIVE) {
+               sr_err("%s: Device instance not active, can't set config.",
+                       sdi->driver->name);
+               ret = SR_ERR_DEV_CLOSED;
+       } else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
                return SR_ERR_ARG;
        else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
                log_key(sdi, cg, key, SR_CONF_SET, data);
@@ -766,6 +881,10 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi,
 
        g_variant_unref(data);
 
+       if (ret == SR_ERR_CHANNEL_GROUP)
+               sr_err("%s: No channel group specified.",
+                       (sdi) ? sdi->driver->name : "unknown");
+
        return ret;
 }
 
@@ -786,7 +905,11 @@ SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
                ret = SR_ERR;
        else if (!sdi->driver->config_commit)
                ret = SR_OK;
-       else
+       else if (sdi->status != SR_ST_ACTIVE) {
+               sr_err("%s: Device instance not active, can't commit config.",
+                       sdi->driver->name);
+               ret = SR_ERR_DEV_CLOSED;
+       } else
                ret = sdi->driver->config_commit(sdi);
 
        return ret;
@@ -796,24 +919,28 @@ SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
  * List all possible values for a configuration key.
  *
  * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
- * @param[in] sdi (optional) If the key is specific to a device, this must
- *            contain a pointer to the struct sr_dev_inst to be checked.
+ * @param[in] sdi (optional) If the key is specific to a device instance, this
+ *            must contain a pointer to the struct sr_dev_inst to be checked.
  *            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.
+ * @param[in] cg The channel group on the device instance for which to list
+ *            the values, or NULL. If this device instance doesn't
+ *            have channel groups, this must not be != NULL.
+ *            If cg is NULL, this function will return the "common" device
+ *            instance options that are channel-group independent. Otherwise
+ *            it will return the channel-group specific options.
  * @param[in] key The configuration key (SR_CONF_*).
  * @param[in,out] data A pointer to a GVariant where the list will be stored.
- *             The caller is given ownership of the GVariant and must thus
- *             unref the GVariant after use. However if this function
- *             returns an error code, the field should be considered
- *             unused, and should not be unreferenced.
+ *                The caller is given ownership of the GVariant and must thus
+ *                unref the GVariant after use. However if this function
+ *                returns an error code, the field should be considered
+ *                unused, and should not be unreferenced.
  *
  * @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
  */
@@ -826,21 +953,50 @@ SR_API int sr_config_list(const struct sr_dev_driver *driver,
 
        if (!driver || !data)
                return SR_ERR;
-       else if (!driver->config_list)
+
+       if (!driver->config_list)
                return SR_ERR_ARG;
-       else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
+
+       if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
                if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
                        return SR_ERR_ARG;
        }
+
        if (sdi && !sdi->priv) {
                sr_err("Can't list config (sdi != NULL, sdi->priv == NULL).");
                return SR_ERR;
        }
+
+       if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS && !sdi) {
+               sr_err("Config keys other than SR_CONF_SCAN_OPTIONS and "
+                      "SR_CONF_DEVICE_OPTIONS always need an sdi.");
+               return SR_ERR_ARG;
+       }
+
+       if (cg && sdi && !sdi->channel_groups) {
+               sr_err("Can't list config for channel group, there are none.");
+               return SR_ERR_ARG;
+       }
+
+       if (cg && sdi && !g_slist_find(sdi->channel_groups, cg)) {
+               sr_err("If a channel group is specified, it must be a valid one.");
+               return SR_ERR_ARG;
+       }
+
+       if (cg && !sdi) {
+               sr_err("Need sdi when a channel group is specified.");
+               return SR_ERR_ARG;
+       }
+
        if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
                log_key(sdi, cg, key, SR_CONF_LIST, *data);
                g_variant_ref_sink(*data);
        }
 
+       if (ret == SR_ERR_CHANNEL_GROUP)
+               sr_err("%s: No channel group specified.",
+                       (sdi) ? sdi->driver->name : "unknown");
+
        return ret;
 }