2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <sys/types.h>
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
31 #define LOG_PREFIX "hwdriver"
37 * Hardware driver handling in libsigrok.
41 * @defgroup grp_driver Hardware drivers
43 * Hardware driver handling in libsigrok.
48 /* Please use the same order/grouping as in enum sr_configkey (libsigrok.h). */
49 static struct sr_key_info sr_key_info_config[] = {
51 {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic analyzer", NULL},
52 {SR_CONF_OSCILLOSCOPE, SR_T_STRING, NULL, "Oscilloscope", NULL},
53 {SR_CONF_MULTIMETER, SR_T_STRING, NULL, "Multimeter", NULL},
54 {SR_CONF_DEMO_DEV, SR_T_STRING, NULL, "Demo device", NULL},
55 {SR_CONF_SOUNDLEVELMETER, SR_T_STRING, NULL, "Sound level meter", NULL},
56 {SR_CONF_THERMOMETER, SR_T_STRING, NULL, "Thermometer", NULL},
57 {SR_CONF_HYGROMETER, SR_T_STRING, NULL, "Hygrometer", NULL},
58 {SR_CONF_ENERGYMETER, SR_T_STRING, NULL, "Energy meter", NULL},
59 {SR_CONF_DEMODULATOR, SR_T_STRING, NULL, "Demodulator", NULL},
60 {SR_CONF_POWER_SUPPLY, SR_T_STRING, NULL, "Power supply", NULL},
61 {SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", NULL},
62 {SR_CONF_ELECTRONIC_LOAD, SR_T_STRING, NULL, "Electronic load", NULL},
63 {SR_CONF_SCALE, SR_T_STRING, NULL, "Scale", NULL},
64 {SR_CONF_SIGNAL_GENERATOR, SR_T_STRING, NULL, "Signal generator", NULL},
66 /* Driver scan options */
67 {SR_CONF_CONN, SR_T_STRING, "conn",
69 {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
70 "Serial communication", NULL},
71 {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr",
72 "Modbus slave address", NULL},
74 /* Device (or channel group) configuration */
75 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
77 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
78 "Pre-trigger capture ratio", NULL},
79 {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
81 {SR_CONF_RLE, SR_T_BOOL, "rle",
82 "Run length encoding", NULL},
83 {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
84 "Trigger slope", NULL},
85 {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
87 {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
88 "Number of samples to average over", NULL},
89 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
90 "Trigger source", NULL},
91 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
92 "Horizontal trigger position", NULL},
93 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
95 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
97 {SR_CONF_FILTER, SR_T_BOOL, "filter",
99 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
101 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
103 {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
104 "Trigger matches", NULL},
105 {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
106 "Sample interval", NULL},
107 {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
108 "Number of horizontal divisions", NULL},
109 {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
110 "Number of vertical divisions", NULL},
111 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
112 "Sound pressure level frequency weighting", NULL},
113 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
114 "Sound pressure level time weighting", NULL},
115 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
116 "Sound pressure level measurement range", NULL},
117 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
119 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
121 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
122 "Voltage threshold", NULL },
123 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
124 "External clock mode", NULL},
125 {SR_CONF_SWAP, SR_T_BOOL, "swap",
126 "Swap channel order", NULL},
127 {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
128 "Center frequency", NULL},
129 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
130 "Number of logic channels", NULL},
131 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
132 "Number of analog channels", NULL},
133 {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage",
134 "Current voltage", NULL},
135 {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target",
136 "Voltage target", NULL},
137 {SR_CONF_CURRENT, SR_T_FLOAT, "current",
138 "Current current", NULL},
139 {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit",
140 "Current limit", NULL},
141 {SR_CONF_ENABLED, SR_T_BOOL, "enabled",
142 "Channel enabled", NULL},
143 {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config",
144 "Channel modes", NULL},
145 {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
146 "Over-voltage protection enabled", NULL},
147 {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
148 "Over-voltage protection active", NULL},
149 {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
150 "Over-voltage protection threshold", NULL},
151 {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
152 "Over-current protection enabled", NULL},
153 {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
154 "Over-current protection active", NULL},
155 {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
156 "Over-current protection threshold", NULL},
157 {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
159 {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
161 {SR_CONF_REGULATION, SR_T_STRING, "regulation",
162 "Channel regulation", NULL},
163 {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
164 "Over-temperature protection", NULL},
165 {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency",
166 "Output frequency", NULL},
167 {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
168 "Output frequency target", NULL},
169 {SR_CONF_MEASURED_QUANTITY, SR_T_MQ, "measured_quantity",
170 "Measured quantity", NULL},
171 {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
172 "Equivalent circuit model", NULL},
173 {SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE, SR_T_BOOL, "otp_active",
174 "Over-temperature protection active", NULL},
175 {SR_CONF_UNDER_VOLTAGE_CONDITION, SR_T_BOOL, "uvc",
176 "Under-voltage condition", NULL},
177 {SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE, SR_T_BOOL, "uvc_active",
178 "Under-voltage condition active", NULL},
179 {SR_CONF_TRIGGER_LEVEL, SR_T_FLOAT, "triggerlevel",
180 "Trigger level", NULL},
183 {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
184 "Session file", NULL},
185 {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile",
186 "Capture file", NULL},
187 {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize",
188 "Capture unitsize", NULL},
189 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
191 {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
192 "Data source", NULL},
193 {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
194 "Probe factor", NULL},
195 {SR_CONF_ADC_POWERLINE_CYCLES, SR_T_FLOAT, "nplc",
196 "Number of ADC powerline cycles", NULL},
198 /* Acquisition modes, sample limiting */
199 {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
201 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
202 "Sample limit", NULL},
203 {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
204 "Frame limit", NULL},
205 {SR_CONF_CONTINUOUS, SR_T_BOOL, "continuous",
206 "Continuous sampling", NULL},
207 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
209 {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
210 "Device mode", NULL},
211 {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
217 /* Please use the same order as in enum sr_mq (libsigrok.h). */
218 static struct sr_key_info sr_key_info_mq[] = {
219 {SR_MQ_VOLTAGE, 0, "voltage", "Voltage", NULL},
220 {SR_MQ_CURRENT, 0, "current", "Current", NULL},
221 {SR_MQ_RESISTANCE, 0, "resistance", "Resistance", NULL},
222 {SR_MQ_CAPACITANCE, 0, "capacitance", "Capacitance", NULL},
223 {SR_MQ_TEMPERATURE, 0, "temperature", "Temperature", NULL},
224 {SR_MQ_FREQUENCY, 0, "frequency", "Frequency", NULL},
225 {SR_MQ_DUTY_CYCLE, 0, "duty_cycle", "Duty cycle", NULL},
226 {SR_MQ_CONTINUITY, 0, "continuity", "Continuity", NULL},
227 {SR_MQ_PULSE_WIDTH, 0, "pulse_width", "Pulse width", NULL},
228 {SR_MQ_CONDUCTANCE, 0, "conductance", "Conductance", NULL},
229 {SR_MQ_POWER, 0, "power", "Power", NULL},
230 {SR_MQ_GAIN, 0, "gain", "Gain", NULL},
231 {SR_MQ_SOUND_PRESSURE_LEVEL, 0, "spl", "Sound pressure level", NULL},
232 {SR_MQ_CARBON_MONOXIDE, 0, "co", "Carbon monoxide", NULL},
233 {SR_MQ_RELATIVE_HUMIDITY, 0, "rh", "Relative humidity", NULL},
234 {SR_MQ_TIME, 0, "time", "Time", NULL},
235 {SR_MQ_WIND_SPEED, 0, "wind_speed", "Wind speed", NULL},
236 {SR_MQ_PRESSURE, 0, "pressure", "Pressure", NULL},
237 {SR_MQ_PARALLEL_INDUCTANCE, 0, "parallel_inductance", "Parallel inductance", NULL},
238 {SR_MQ_PARALLEL_CAPACITANCE, 0, "parallel_capacitance", "Parallel capacitance", NULL},
239 {SR_MQ_PARALLEL_RESISTANCE, 0, "parallel_resistance", "Parallel resistance", NULL},
240 {SR_MQ_SERIES_INDUCTANCE, 0, "series_inductance", "Series inductance", NULL},
241 {SR_MQ_SERIES_CAPACITANCE, 0, "series_capacitance", "Series capacitance", NULL},
242 {SR_MQ_SERIES_RESISTANCE, 0, "series_resistance", "Series resistance", NULL},
243 {SR_MQ_DISSIPATION_FACTOR, 0, "dissipation_factor", "Dissipation factor", NULL},
244 {SR_MQ_QUALITY_FACTOR, 0, "quality_factor", "Quality factor", NULL},
245 {SR_MQ_PHASE_ANGLE, 0, "phase_angle", "Phase angle", NULL},
246 {SR_MQ_DIFFERENCE, 0, "difference", "Difference", NULL},
247 {SR_MQ_COUNT, 0, "count", "Count", NULL},
248 {SR_MQ_POWER_FACTOR, 0, "power_factor", "Power factor", NULL},
249 {SR_MQ_APPARENT_POWER, 0, "apparent_power", "Apparent power", NULL},
250 {SR_MQ_MASS, 0, "mass", "Mass", NULL},
251 {SR_MQ_HARMONIC_RATIO, 0, "harmonic_ratio", "Harmonic ratio", NULL},
255 /* Please use the same order as in enum sr_mqflag (libsigrok.h). */
256 static struct sr_key_info sr_key_info_mqflag[] = {
257 {SR_MQFLAG_AC, 0, "ac", "AC", NULL},
258 {SR_MQFLAG_DC, 0, "dc", "DC", NULL},
259 {SR_MQFLAG_RMS, 0, "rms", "RMS", NULL},
260 {SR_MQFLAG_DIODE, 0, "diode", "Diode", NULL},
261 {SR_MQFLAG_HOLD, 0, "hold", "Hold", NULL},
262 {SR_MQFLAG_MAX, 0, "max", "Max", NULL},
263 {SR_MQFLAG_MIN, 0, "min", "Min", NULL},
264 {SR_MQFLAG_AUTORANGE, 0, "auto_range", "Auto range", NULL},
265 {SR_MQFLAG_RELATIVE, 0, "relative", "Relative", NULL},
266 {SR_MQFLAG_SPL_FREQ_WEIGHT_A, 0, "spl_freq_weight_a",
267 "Frequency weighted (A)", NULL},
268 {SR_MQFLAG_SPL_FREQ_WEIGHT_C, 0, "spl_freq_weight_c",
269 "Frequency weighted (C)", NULL},
270 {SR_MQFLAG_SPL_FREQ_WEIGHT_Z, 0, "spl_freq_weight_z",
271 "Frequency weighted (Z)", NULL},
272 {SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, 0, "spl_freq_weight_flat",
273 "Frequency weighted (flat)", NULL},
274 {SR_MQFLAG_SPL_TIME_WEIGHT_S, 0, "spl_time_weight_s",
275 "Time weighted (S)", NULL},
276 {SR_MQFLAG_SPL_TIME_WEIGHT_F, 0, "spl_time_weight_f",
277 "Time weighted (F)", NULL},
278 {SR_MQFLAG_SPL_LAT, 0, "spl_time_average", "Time-averaged (LEQ)", NULL},
279 {SR_MQFLAG_SPL_PCT_OVER_ALARM, 0, "spl_pct_over_alarm",
280 "Percentage over alarm", NULL},
281 {SR_MQFLAG_DURATION, 0, "duration", "Duration", NULL},
282 {SR_MQFLAG_AVG, 0, "average", "Average", NULL},
283 {SR_MQFLAG_REFERENCE, 0, "reference", "Reference", NULL},
284 {SR_MQFLAG_UNSTABLE, 0, "unstable", "Unstable", NULL},
285 {SR_MQFLAG_FOUR_WIRE, 0, "four_wire", "4-Wire", NULL},
289 /* This must handle all the keys from enum sr_datatype (libsigrok.h). */
291 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
295 return G_VARIANT_TYPE_INT32;
297 return G_VARIANT_TYPE_UINT64;
299 return G_VARIANT_TYPE_STRING;
301 return G_VARIANT_TYPE_BOOLEAN;
303 return G_VARIANT_TYPE_DOUBLE;
304 case SR_T_RATIONAL_PERIOD:
305 case SR_T_RATIONAL_VOLT:
306 case SR_T_UINT64_RANGE:
307 case SR_T_DOUBLE_RANGE:
308 return G_VARIANT_TYPE_TUPLE;
310 return G_VARIANT_TYPE_DICTIONARY;
312 return G_VARIANT_TYPE_TUPLE;
319 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
321 const struct sr_key_info *info;
322 const GVariantType *type, *expected;
323 char *expected_string, *type_string;
325 info = sr_key_info_get(SR_KEY_CONFIG, key);
329 expected = sr_variant_type_get(info->datatype);
330 type = g_variant_get_type(value);
331 if (!g_variant_type_equal(type, expected)
332 && !g_variant_type_is_subtype_of(type, expected)) {
333 expected_string = g_variant_type_dup_string(expected);
334 type_string = g_variant_type_dup_string(type);
335 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
336 info->name, expected_string, type_string);
337 g_free(expected_string);
346 * Return the list of supported hardware drivers.
348 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
350 * @retval NULL The ctx argument was NULL, or there are no supported drivers.
351 * @retval Other Pointer to the NULL-terminated list of hardware drivers.
352 * The user should NOT g_free() this list, sr_exit() will do that.
356 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
361 return ctx->driver_list;
365 * Initialize a hardware driver.
367 * This usually involves memory allocations and variable initializations
368 * within the driver, but _not_ scanning for attached devices.
369 * The API call sr_driver_scan() is used for that.
371 * @param ctx A libsigrok context object allocated by a previous call to
372 * sr_init(). Must not be NULL.
373 * @param driver The driver to initialize. This must be a pointer to one of
374 * the entries returned by sr_driver_list(). Must not be NULL.
376 * @retval SR_OK Success
377 * @retval SR_ERR_ARG Invalid parameter(s).
378 * @retval SR_ERR_BUG Internal errors.
379 * @retval other Another negative error code upon other errors.
383 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
388 sr_err("Invalid libsigrok context, can't initialize.");
393 sr_err("Invalid driver, can't initialize.");
397 /* No log message here, too verbose and not very useful. */
399 if ((ret = driver->init(driver, ctx)) < 0)
400 sr_err("Failed to initialize the driver: %d.", ret);
406 * Enumerate scan options supported by this driver.
408 * Before calling sr_driver_scan_options_list(), the user must have previously
409 * initialized the driver by calling sr_driver_init().
411 * @param driver The driver to enumerate options for. This must be a pointer
412 * to one of the entries returned by sr_driver_list(). Must not
415 * @return A GArray * of uint32_t entries, or NULL on invalid arguments. Each
416 * entry is a configuration key that is supported as a scan option.
417 * The array must be freed by the caller using g_array_free().
421 SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver)
424 const uint32_t *opts;
428 if (sr_config_list(driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, &gvar) != SR_OK)
431 opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
433 result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
435 g_array_insert_vals(result, 0, opts, num_opts);
437 g_variant_unref(gvar);
442 static int check_options(struct sr_dev_driver *driver, GSList *options,
443 uint32_t optlist_key, struct sr_dev_inst *sdi,
444 struct sr_channel_group *cg)
446 struct sr_config *src;
447 const struct sr_key_info *srci;
450 const uint32_t *opts;
454 if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
455 /* Driver publishes no options for this optlist. */
460 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
461 for (l = options; l; l = l->next) {
463 for (i = 0; i < num_opts; i++) {
464 if (opts[i] == src->key)
468 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key)))
469 /* Shouldn't happen. */
470 sr_err("Invalid option %d.", src->key);
472 sr_err("Invalid option '%s'.", srci->id);
476 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
481 g_variant_unref(gvar_opts);
487 * Tell a hardware driver to scan for devices.
489 * In addition to the detection, the devices that are found are also
490 * initialized automatically. On some devices, this involves a firmware upload,
491 * or other such measures.
493 * The order in which the system is scanned for devices is not specified. The
494 * caller should not assume or rely on any specific order.
496 * Before calling sr_driver_scan(), the user must have previously initialized
497 * the driver by calling sr_driver_init().
499 * @param driver The driver that should scan. This must be a pointer to one of
500 * the entries returned by sr_driver_list(). Must not be NULL.
501 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
502 * scanner. Can be NULL/empty.
504 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
505 * found (or errors were encountered). This list must be freed by the
506 * caller using g_slist_free(), but without freeing the data pointed
511 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
516 sr_err("Invalid driver, can't scan for devices.");
520 if (!driver->context) {
521 sr_err("Driver not initialized, can't scan for devices.");
526 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
530 l = driver->scan(driver, options);
532 sr_spew("Scan found %d devices (%s).", g_slist_length(l), driver->name);
538 * Call driver cleanup function for all drivers.
540 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
544 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
547 struct sr_dev_driver **drivers;
552 sr_dbg("Cleaning up all drivers.");
554 drivers = sr_driver_list(ctx);
555 for (i = 0; drivers[i]; i++) {
556 if (drivers[i]->cleanup)
557 drivers[i]->cleanup(drivers[i]);
558 drivers[i]->context = NULL;
563 * Allocate struct sr_config.
565 * A floating reference can be passed in for data.
569 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
571 struct sr_config *src;
573 src = g_malloc0(sizeof(struct sr_config));
575 src->data = g_variant_ref_sink(data);
581 * Free struct sr_config.
585 SR_PRIV void sr_config_free(struct sr_config *src)
587 if (!src || !src->data) {
588 sr_err("%s: invalid data!", __func__);
592 g_variant_unref(src->data);
597 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi)
599 if (!sdi || !sdi->driver) {
600 sr_err("%s: Invalid arguments.", __func__);
604 if (sdi->status != SR_ST_ACTIVE) {
605 sr_err("%s: Device instance not active, can't start.",
607 return SR_ERR_DEV_CLOSED;
610 sr_dbg("%s: Starting acquisition.", sdi->driver->name);
612 return sdi->driver->dev_acquisition_start(sdi);
616 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi)
618 if (!sdi || !sdi->driver) {
619 sr_err("%s: Invalid arguments.", __func__);
623 if (sdi->status != SR_ST_ACTIVE) {
624 sr_err("%s: Device instance not active, can't stop.",
626 return SR_ERR_DEV_CLOSED;
629 sr_dbg("%s: Stopping acquisition.", sdi->driver->name);
631 return sdi->driver->dev_acquisition_stop(sdi);
634 static void log_key(const struct sr_dev_inst *sdi,
635 const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
638 const struct sr_key_info *srci;
641 /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
642 if (key == SR_CONF_DEVICE_OPTIONS)
645 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
646 srci = sr_key_info_get(SR_KEY_CONFIG, key);
648 tmp_str = g_variant_print(data, TRUE);
649 sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
650 srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
651 data ? tmp_str : "NULL");
655 static int check_key(const struct sr_dev_driver *driver,
656 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
657 uint32_t key, int op, GVariant *data)
659 const struct sr_key_info *srci;
662 const uint32_t *opts;
668 suffix = " for this device and channel group";
670 suffix = " for this device";
674 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, key))) {
675 sr_err("Invalid key %d.", key);
678 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
681 case SR_CONF_LIMIT_MSEC:
682 case SR_CONF_LIMIT_SAMPLES:
683 case SR_CONF_SAMPLERATE:
684 /* Setting any of these to 0 is not useful. */
685 if (op != SR_CONF_SET || !data)
687 if (g_variant_get_uint64(data) == 0) {
688 sr_err("Cannot set '%s' to 0.", srci->id);
694 if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
695 /* Driver publishes no options. */
696 sr_err("No options available%s.", suffix);
699 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
701 for (i = 0; i < num_opts; i++) {
702 if ((opts[i] & SR_CONF_MASK) == key) {
707 g_variant_unref(gvar_opts);
709 sr_err("Option '%s' not available%s.", srci->id, suffix);
713 if (!(pub_opt & op)) {
714 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
722 * Query value of a configuration key at the given driver or device instance.
724 * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
725 * @param[in] sdi (optional) If the key is specific to a device, this must
726 * contain a pointer to the struct sr_dev_inst to be checked.
727 * Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
729 * @param[in] cg The channel group on the device for which to list the
731 * @param[in] key The configuration key (SR_CONF_*).
732 * @param[in,out] data Pointer to a GVariant where the value will be stored.
733 * Must not be NULL. The caller is given ownership of the GVariant
734 * and must thus decrease the refcount after use. However if
735 * this function returns an error code, the field should be
736 * considered unused, and should not be unreferenced.
738 * @retval SR_OK Success.
739 * @retval SR_ERR Error.
740 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
741 * interpreted as an error by the caller; merely as an indication
742 * that it's not applicable.
746 SR_API int sr_config_get(const struct sr_dev_driver *driver,
747 const struct sr_dev_inst *sdi,
748 const struct sr_channel_group *cg,
749 uint32_t key, GVariant **data)
753 if (!driver || !data)
756 if (!driver->config_get)
759 if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
762 if (sdi && !sdi->priv) {
763 sr_err("Can't get config (sdi != NULL, sdi->priv == NULL).");
767 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
768 log_key(sdi, cg, key, SR_CONF_GET, *data);
769 /* Got a floating reference from the driver. Sink it here,
770 * caller will need to unref when done with it. */
771 g_variant_ref_sink(*data);
778 * Set value of a configuration key in a device instance.
780 * @param[in] sdi The device instance. Must not be NULL. sdi->driver and
781 * sdi->priv must not be NULL either.
782 * @param[in] cg The channel group on the device for which to list the
784 * @param[in] key The configuration key (SR_CONF_*).
785 * @param data The new value for the key, as a GVariant with GVariantType
786 * appropriate to that key. A floating reference can be passed
787 * in; its refcount will be sunk and unreferenced after use.
789 * @retval SR_OK Success.
790 * @retval SR_ERR Error.
791 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
792 * interpreted as an error by the caller; merely as an indication
793 * that it's not applicable.
797 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
798 const struct sr_channel_group *cg,
799 uint32_t key, GVariant *data)
803 g_variant_ref_sink(data);
805 if (!sdi || !sdi->driver || !sdi->priv || !data)
807 else if (!sdi->driver->config_set)
809 else if (sdi->status != SR_ST_ACTIVE) {
810 sr_err("%s: Device instance not active, can't set config.",
812 ret = SR_ERR_DEV_CLOSED;
813 } else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
815 else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
816 log_key(sdi, cg, key, SR_CONF_SET, data);
817 ret = sdi->driver->config_set(key, data, sdi, cg);
820 g_variant_unref(data);
826 * Apply configuration settings to the device hardware.
828 * @param sdi The device instance.
830 * @return SR_OK upon success or SR_ERR in case of error.
834 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
838 if (!sdi || !sdi->driver)
840 else if (!sdi->driver->config_commit)
842 else if (sdi->status != SR_ST_ACTIVE) {
843 sr_err("%s: Device instance not active, can't commit config.",
845 ret = SR_ERR_DEV_CLOSED;
847 ret = sdi->driver->config_commit(sdi);
853 * List all possible values for a configuration key.
855 * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
856 * @param[in] sdi (optional) If the key is specific to a device, this must
857 * contain a pointer to the struct sr_dev_inst to be checked.
858 * Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
860 * @param[in] cg The channel group on the device for which to list the
862 * @param[in] key The configuration key (SR_CONF_*).
863 * @param[in,out] data A pointer to a GVariant where the list will be stored.
864 * The caller is given ownership of the GVariant and must thus
865 * unref the GVariant after use. However if this function
866 * returns an error code, the field should be considered
867 * unused, and should not be unreferenced.
869 * @retval SR_OK Success.
870 * @retval SR_ERR Error.
871 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
872 * interpreted as an error by the caller; merely as an indication
873 * that it's not applicable.
877 SR_API int sr_config_list(const struct sr_dev_driver *driver,
878 const struct sr_dev_inst *sdi,
879 const struct sr_channel_group *cg,
880 uint32_t key, GVariant **data)
884 if (!driver || !data)
886 else if (!driver->config_list)
888 else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
889 if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
892 if (sdi && !sdi->priv) {
893 sr_err("Can't list config (sdi != NULL, sdi->priv == NULL).");
896 if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
897 log_key(sdi, cg, key, SR_CONF_LIST, *data);
898 g_variant_ref_sink(*data);
904 static struct sr_key_info *get_keytable(int keytype)
906 struct sr_key_info *table;
910 table = sr_key_info_config;
913 table = sr_key_info_mq;
916 table = sr_key_info_mqflag;
919 sr_err("Invalid keytype %d", keytype);
927 * Get information about a key, by key.
929 * @param[in] keytype The namespace the key is in.
930 * @param[in] key The key to find.
932 * @return A pointer to a struct sr_key_info, or NULL if the key
937 SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key)
939 struct sr_key_info *table;
942 if (!(table = get_keytable(keytype)))
945 for (i = 0; table[i].key; i++) {
946 if (table[i].key == key)
954 * Get information about a key, by name.
956 * @param[in] keytype The namespace the key is in.
957 * @param[in] keyid The key id string.
959 * @return A pointer to a struct sr_key_info, or NULL if the key
964 SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid)
966 struct sr_key_info *table;
969 if (!(table = get_keytable(keytype)))
972 for (i = 0; table[i].key; i++) {
975 if (!strcmp(table[i].id, keyid))