* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include <config.h>
#include <stdlib.h>
#include <stdio.h>
#include <sys/types.h>
#include <dirent.h>
#include <string.h>
#include <glib.h>
-#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
{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},
/* Driver scan options */
{SR_CONF_CONN, SR_T_STRING, "conn",
"Output frequency", NULL},
{SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
"Output frequency target", NULL},
- {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity",
+ {SR_CONF_MEASURED_QUANTITY, SR_T_MQ, "measured_quantity",
"Measured quantity", NULL},
- {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity",
- "Measured secondary quantity", NULL},
{SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
"Equivalent circuit model", NULL},
{SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE, SR_T_BOOL, "otp_active",
"Over-temperature protection active", NULL},
+ {SR_CONF_UNDER_VOLTAGE_CONDITION, SR_T_BOOL, "uvc",
+ "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},
/* Special stuff */
- {SR_CONF_SCAN_OPTIONS, SR_T_STRING, "scan_options",
- "Scan options", NULL},
- {SR_CONF_DEVICE_OPTIONS, SR_T_STRING, "device_options",
- "Device options", NULL},
{SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
"Session file", NULL},
{SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile",
"Data source", NULL},
{SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
"Probe factor", NULL},
+ {SR_CONF_ADC_POWERLINE_CYCLES, SR_T_FLOAT, "nplc",
+ "Number of ADC powerline cycles", NULL},
/* Acquisition modes, sample limiting */
{SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
"Sample limit", NULL},
{SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
"Frame limit", NULL},
- {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous",
+ {SR_CONF_CONTINUOUS, SR_T_BOOL, "continuous",
"Continuous sampling", NULL},
{SR_CONF_DATALOG, SR_T_BOOL, "datalog",
"Datalog", NULL},
{SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
"Test mode", NULL},
- {0, 0, NULL, NULL, NULL},
+ ALL_ZERO
};
/* Please use the same order as in enum sr_mq (libsigrok.h). */
{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
};
{SR_MQFLAG_AVG, 0, "average", "Average", NULL},
{SR_MQFLAG_REFERENCE, 0, "reference", "Reference", NULL},
{SR_MQFLAG_UNSTABLE, 0, "unstable", "Unstable", NULL},
+ {SR_MQFLAG_FOUR_WIRE, 0, "four_wire", "4-Wire", NULL},
ALL_ZERO
};
/* 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) {
return G_VARIANT_TYPE_TUPLE;
case SR_T_KEYVALUE:
return G_VARIANT_TYPE_DICTIONARY;
- case SR_T_MQLIST:
- return G_VARIANT_TYPE_ARRAY;
+ case SR_T_MQ:
+ return G_VARIANT_TYPE_TUPLE;
default:
return NULL;
}
}
+/** @private */
SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
{
const struct sr_key_info *info;
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);
return ret;
}
+/**
+ * Enumerate scan options supported by this driver.
+ *
+ * Before calling sr_driver_scan_options_list(), the user must have previously
+ * initialized the driver by calling sr_driver_init().
+ *
+ * @param driver The driver to enumerate options for. This must be a pointer
+ * to one of the entries returned by sr_driver_list(). Must not
+ * be NULL.
+ *
+ * @return A GArray * of uint32_t entries, or NULL on invalid arguments. Each
+ * entry is a configuration key that is supported as a scan option.
+ * The array must be freed by the caller using g_array_free().
+ *
+ * @since 0.4.0
+ */
+SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver)
+{
+ GVariant *gvar;
+ const uint32_t *opts;
+ gsize num_opts;
+ GArray *result;
+
+ if (sr_config_list(driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, &gvar) != SR_OK)
+ return NULL;
+
+ opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
+
+ result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
+
+ g_array_insert_vals(result, 0, opts, num_opts);
+
+ g_variant_unref(gvar);
+
+ return result;
+}
+
static int check_options(struct sr_dev_driver *driver, GSList *options,
uint32_t optlist_key, struct sr_dev_inst *sdi,
struct sr_channel_group *cg)
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;
}
if (!ctx)
return;
+ sr_dbg("Cleaning up all drivers.");
+
drivers = sr_driver_list(ctx);
for (i = 0; drivers[i]; i++) {
if (drivers[i]->cleanup)
}
}
-/** 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)
{
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;
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;
+ gchar *tmp_str;
/* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
if (key == SR_CONF_DEVICE_OPTIONS)
opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
srci = sr_key_info_get(SR_KEY_CONFIG, key);
+ tmp_str = g_variant_print(data, TRUE);
sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
- data ? g_variant_print(data, TRUE) : "NULL");
+ data ? tmp_str : "NULL");
+ g_free(tmp_str);
}
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;
GVariant *gvar_opts;
const uint32_t *opts;
uint32_t pub_opt;
- char *suffix, *opstr;
+ const char *suffix;
+ 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 = "";
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) {
/* Driver publishes no options. */
- sr_err("No options available%s.", srci->id, suffix);
+ sr_err("No options available%s.", suffix);
return SR_ERR_ARG;
}
opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
/**
* Query value of a configuration key at the given driver or device instance.
*
- * @param[in] driver The sr_dev_driver struct to query.
+ * @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.
- * Otherwise it must be NULL.
+ * 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
* @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
*/
if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
return SR_ERR_ARG;
+ if (sdi && !sdi->priv) {
+ sr_err("Can't get config (sdi != NULL, sdi->priv == NULL).");
+ return SR_ERR;
+ }
+
if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
log_key(sdi, cg, key, SR_CONF_GET, *data);
/* Got a floating reference from the driver. Sink it here,
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;
}
/**
* Set value of a configuration key in a device instance.
*
- * @param[in] sdi The device instance.
+ * @param[in] sdi The device instance. Must not be NULL. sdi->driver and
+ * sdi->priv must not be NULL either.
* @param[in] cg The channel group on the device for which to list the
* values, or NULL.
* @param[in] key The configuration key (SR_CONF_*).
* @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
*/
g_variant_ref_sink(data);
- if (!sdi || !sdi->driver || !data)
+ if (!sdi || !sdi->driver || !sdi->priv || !data)
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);
g_variant_unref(data);
+ if (ret == SR_ERR_CHANNEL_GROUP)
+ sr_err("%s: No channel group specified.",
+ (sdi) ? sdi->driver->name : "unknown");
+
return ret;
}
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;
/**
* List all possible values for a configuration key.
*
- * @param[in] driver The sr_dev_driver struct to query.
- * @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] cg The channel group on the device for which to list the
- * values, or NULL.
+ * @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 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 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
*/
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;
}