#define LOG_PREFIX "hwdriver"
/** @endcond */
-extern SR_PRIV struct sr_dev_driver *drivers_list[];
-
/**
* @file
*
* @{
*/
+/* Same key order/grouping as in enum sr_configkey (libsigrok.h). */
static struct sr_config_info sr_config_info_data[] = {
- /* Device types */
- {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic Analyzer", NULL},
+ /* Device classes */
+ {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic analyzer", NULL},
{SR_CONF_OSCILLOSCOPE, SR_T_STRING, NULL, "Oscilloscope", NULL},
{SR_CONF_MULTIMETER, SR_T_STRING, NULL, "Multimeter", NULL},
{SR_CONF_DEMO_DEV, SR_T_STRING, NULL, "Demo device", NULL},
{SR_CONF_POWER_SUPPLY, SR_T_STRING, NULL, "Power supply", NULL},
{SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", NULL},
- /* Sample limiting */
- {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
- "Sample limit", NULL},
- {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
- "Time limit", NULL},
- {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
- "Frame limit", NULL},
- {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous",
- "Continuous sampling", NULL},
-
- /* Scan options */
+ /* Driver scan options */
{SR_CONF_CONN, SR_T_STRING, "conn",
"Connection", NULL},
{SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
"Serial communication", NULL},
- /* Device/channel group options */
+ /* Device (or channel group) configuration */
{SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
"Sample rate", NULL},
{SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
"Pre-trigger capture ratio", NULL},
{SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
"Pattern", NULL},
- {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
- "Trigger matches", NULL},
- {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
- "External clock mode", NULL},
- {SR_CONF_SWAP, SR_T_BOOL, "swap",
- "Swap channel order", NULL},
{SR_CONF_RLE, SR_T_BOOL, "rle",
- "Run Length Encoding", NULL},
+ "Run length encoding", NULL},
{SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
"Trigger slope", NULL},
+ {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
+ "Averaging", NULL},
+ {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
+ "Number of samples to average over", NULL},
{SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
"Trigger source", NULL},
{SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
"Volts/div", NULL},
{SR_CONF_COUPLING, SR_T_STRING, "coupling",
"Coupling", NULL},
- {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
- "Datalog", NULL},
+ {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
+ "Trigger matches", NULL},
+ {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
+ "Sample interval", NULL},
+ {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
+ "Number of horizontal divisions", NULL},
+ {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
+ "Number of vertical divisions", NULL},
{SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
"Sound pressure level frequency weighting", NULL},
{SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
"Sound pressure level time weighting", NULL},
+ {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
+ "Sound pressure level measurement range", NULL},
{SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
"Hold max", NULL},
{SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
"Hold min", NULL},
- {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
- "Sound pressure level measurement range", NULL},
{SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
"Voltage threshold", NULL },
- {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
- "Power off", NULL},
- {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
- "Data source", NULL},
+ {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
+ "External clock mode", NULL},
+ {SR_CONF_SWAP, SR_T_BOOL, "swap",
+ "Swap channel order", NULL},
+ {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
+ "Center frequency", NULL},
{SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
"Number of logic channels", NULL},
{SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
"Clock edge", NULL},
{SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
"Amplitude", NULL},
- {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
- "Over-temperature protection", NULL},
{SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation",
"Output channel regulation", NULL},
+ {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
+ "Over-temperature protection", NULL},
{SR_CONF_OUTPUT_FREQUENCY, SR_T_UINT64, "output_frequency",
"Output frequency", NULL},
{SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity",
"Measured secondary quantity", NULL},
{SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
"Equivalent circuit model", 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",
+ "Capture file", NULL},
+ {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize",
+ "Capture unitsize", NULL},
+ {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
+ "Power off", NULL},
+ {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
+ "Data source", NULL},
+ {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
+ "Probe factor", NULL},
+
+ /* Acquisition modes, sample limiting */
+ {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
+ "Time limit", NULL},
+ {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
+ "Sample limit", NULL},
+ {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
+ "Frame limit", NULL},
+ {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous",
+ "Continuous sampling", NULL},
+ {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
+ "Datalog", NULL},
+ {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
+ "Device mode", NULL},
+ {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
+ "Test mode", NULL},
+
{0, 0, NULL, NULL, NULL},
};
/**
* Return the list of supported hardware drivers.
*
- * @return Pointer to the NULL-terminated list of hardware driver pointers.
+ * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
+ *
+ * @retval NULL The ctx argument was NULL, or there are no supported drivers.
+ * @retval Other Pointer to the NULL-terminated list of hardware drivers.
+ * The user should NOT g_free() this list, sr_exit() will do that.
*
- * @since 0.1.0
+ * @since 0.4.0
*/
-SR_API struct sr_dev_driver **sr_driver_list(void)
+SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
{
+ if (!ctx)
+ return NULL;
- return drivers_list;
+ return ctx->driver_list;
}
/**
}
sr_spew("Initializing driver '%s'.", driver->name);
- if ((ret = driver->init(ctx)) < 0)
+ if ((ret = driver->init(driver, ctx)) < 0)
sr_err("Failed to initialize the driver: %d.", ret);
return ret;
return NULL;
}
- l = driver->scan(options);
+ l = driver->scan(driver, options);
sr_spew("Scan of '%s' found %d devices.", driver->name,
g_slist_length(l));
return l;
}
-/** Call driver cleanup function for all drivers.
- * @private */
-SR_PRIV void sr_hw_cleanup_all(void)
+/**
+ * Call driver cleanup function for all drivers.
+ *
+ * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
+ *
+ * @private
+ */
+SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
{
int i;
struct sr_dev_driver **drivers;
- drivers = sr_driver_list();
+ if (!ctx)
+ return;
+
+ drivers = sr_driver_list(ctx);
for (i = 0; drivers[i]; i++) {
if (drivers[i]->cleanup)
- drivers[i]->cleanup();
+ drivers[i]->cleanup(drivers[i]);
+ drivers[i]->priv = NULL;
}
}
{
struct sr_config *src;
- if (!(src = g_try_malloc(sizeof(struct sr_config))))
- return NULL;
+ src = g_malloc0(sizeof(struct sr_config));
src->key = key;
src->data = g_variant_ref_sink(data);
}
+static void log_key(const struct sr_dev_inst *sdi,
+ const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
+{
+ const char *opstr;
+ const struct sr_config_info *srci;
+
+ /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
+ if (key == SR_CONF_DEVICE_OPTIONS)
+ return;
+
+ opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
+ srci = sr_config_info_get(key);
+
+ 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");
+}
+
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)
+ uint32_t key, int op, GVariant *data)
{
const struct sr_config_info *srci;
gsize num_opts, i;
}
opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
+ switch (key) {
+ case SR_CONF_LIMIT_MSEC:
+ case SR_CONF_LIMIT_SAMPLES:
+ case SR_CONF_SAMPLERATE:
+ /* Setting any of these to 0 is not useful. */
+ if (op != SR_CONF_SET || !data)
+ break;
+ if (g_variant_get_uint64(data) == 0) {
+ sr_err("Cannot set '%s' to 0.", srci->id);
+ 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);
if (!driver->config_get)
return SR_ERR_ARG;
- if (check_key(driver, sdi, cg, key, SR_CONF_GET) != SR_OK)
+ if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
return SR_ERR_ARG;
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,
* caller will need to unref when done with it. */
g_variant_ref_sink(*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) != SR_OK)
+ 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)
+ else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
+ log_key(sdi, cg, key, SR_CONF_SET, data);
ret = sdi->driver->config_set(key, data, sdi, cg);
+ }
g_variant_unref(data);
int ret;
if (!driver || !data)
- ret = SR_ERR;
+ return SR_ERR;
else if (!driver->config_list)
- ret = SR_ERR_ARG;
+ return SR_ERR_ARG;
else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
- if (check_key(driver, sdi, cg, key, SR_CONF_LIST) != SR_OK)
+ if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
return SR_ERR_ARG;
}
- else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
+ 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);
+ }
return ret;
}
projects / libsigrok.git / blobdiff