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},
65 /* Driver scan options */
66 {SR_CONF_CONN, SR_T_STRING, "conn",
68 {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
69 "Serial communication", NULL},
70 {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr",
71 "Modbus slave address", NULL},
73 /* Device (or channel group) configuration */
74 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
76 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
77 "Pre-trigger capture ratio", NULL},
78 {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
80 {SR_CONF_RLE, SR_T_BOOL, "rle",
81 "Run length encoding", NULL},
82 {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
83 "Trigger slope", NULL},
84 {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
86 {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
87 "Number of samples to average over", NULL},
88 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
89 "Trigger source", NULL},
90 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
91 "Horizontal trigger position", NULL},
92 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
94 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
96 {SR_CONF_FILTER, SR_T_BOOL, "filter",
98 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
100 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
102 {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
103 "Trigger matches", NULL},
104 {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
105 "Sample interval", NULL},
106 {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
107 "Number of horizontal divisions", NULL},
108 {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
109 "Number of vertical divisions", NULL},
110 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
111 "Sound pressure level frequency weighting", NULL},
112 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
113 "Sound pressure level time weighting", NULL},
114 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
115 "Sound pressure level measurement range", NULL},
116 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
118 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
120 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
121 "Voltage threshold", NULL },
122 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
123 "External clock mode", NULL},
124 {SR_CONF_SWAP, SR_T_BOOL, "swap",
125 "Swap channel order", NULL},
126 {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
127 "Center frequency", NULL},
128 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
129 "Number of logic channels", NULL},
130 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
131 "Number of analog channels", NULL},
132 {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage",
133 "Current voltage", NULL},
134 {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target",
135 "Voltage target", NULL},
136 {SR_CONF_CURRENT, SR_T_FLOAT, "current",
137 "Current current", NULL},
138 {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit",
139 "Current limit", NULL},
140 {SR_CONF_ENABLED, SR_T_BOOL, "enabled",
141 "Channel enabled", NULL},
142 {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config",
143 "Channel modes", NULL},
144 {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
145 "Over-voltage protection enabled", NULL},
146 {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
147 "Over-voltage protection active", NULL},
148 {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
149 "Over-voltage protection threshold", NULL},
150 {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
151 "Over-current protection enabled", NULL},
152 {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
153 "Over-current protection active", NULL},
154 {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
155 "Over-current protection threshold", NULL},
156 {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
158 {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
160 {SR_CONF_REGULATION, SR_T_STRING, "regulation",
161 "Channel regulation", NULL},
162 {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
163 "Over-temperature protection", NULL},
164 {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency",
165 "Output frequency", NULL},
166 {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
167 "Output frequency target", NULL},
168 {SR_CONF_MEASURED_QUANTITY, SR_T_MQ, "measured_quantity",
169 "Measured quantity", NULL},
170 {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
171 "Equivalent circuit model", NULL},
172 {SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE, SR_T_BOOL, "otp_active",
173 "Over-temperature protection active", NULL},
174 {SR_CONF_UNDER_VOLTAGE_CONDITION, SR_T_BOOL, "uvc",
175 "Under-voltage condition", NULL},
176 {SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE, SR_T_BOOL, "uvc_active",
177 "Under-voltage condition active", NULL},
180 {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
181 "Session file", NULL},
182 {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile",
183 "Capture file", NULL},
184 {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize",
185 "Capture unitsize", NULL},
186 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
188 {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
189 "Data source", NULL},
190 {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
191 "Probe factor", NULL},
192 {SR_CONF_ADC_POWERLINE_CYCLES, SR_T_FLOAT, "nplc",
193 "Number of ADC powerline cycles", NULL},
195 /* Acquisition modes, sample limiting */
196 {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
198 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
199 "Sample limit", NULL},
200 {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
201 "Frame limit", NULL},
202 {SR_CONF_CONTINUOUS, SR_T_BOOL, "continuous",
203 "Continuous sampling", NULL},
204 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
206 {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
207 "Device mode", NULL},
208 {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
214 /* Please use the same order as in enum sr_mq (libsigrok.h). */
215 static struct sr_key_info sr_key_info_mq[] = {
216 {SR_MQ_VOLTAGE, 0, "voltage", "Voltage", NULL},
217 {SR_MQ_CURRENT, 0, "current", "Current", NULL},
218 {SR_MQ_RESISTANCE, 0, "resistance", "Resistance", NULL},
219 {SR_MQ_CAPACITANCE, 0, "capacitance", "Capacitance", NULL},
220 {SR_MQ_TEMPERATURE, 0, "temperature", "Temperature", NULL},
221 {SR_MQ_FREQUENCY, 0, "frequency", "Frequency", NULL},
222 {SR_MQ_DUTY_CYCLE, 0, "duty_cycle", "Duty cycle", NULL},
223 {SR_MQ_CONTINUITY, 0, "continuity", "Continuity", NULL},
224 {SR_MQ_PULSE_WIDTH, 0, "pulse_width", "Pulse width", NULL},
225 {SR_MQ_CONDUCTANCE, 0, "conductance", "Conductance", NULL},
226 {SR_MQ_POWER, 0, "power", "Power", NULL},
227 {SR_MQ_GAIN, 0, "gain", "Gain", NULL},
228 {SR_MQ_SOUND_PRESSURE_LEVEL, 0, "spl", "Sound pressure level", NULL},
229 {SR_MQ_CARBON_MONOXIDE, 0, "co", "Carbon monoxide", NULL},
230 {SR_MQ_RELATIVE_HUMIDITY, 0, "rh", "Relative humidity", NULL},
231 {SR_MQ_TIME, 0, "time", "Time", NULL},
232 {SR_MQ_WIND_SPEED, 0, "wind_speed", "Wind speed", NULL},
233 {SR_MQ_PRESSURE, 0, "pressure", "Pressure", NULL},
234 {SR_MQ_PARALLEL_INDUCTANCE, 0, "parallel_inductance", "Parallel inductance", NULL},
235 {SR_MQ_PARALLEL_CAPACITANCE, 0, "parallel_capacitance", "Parallel capacitance", NULL},
236 {SR_MQ_PARALLEL_RESISTANCE, 0, "parallel_resistance", "Parallel resistance", NULL},
237 {SR_MQ_SERIES_INDUCTANCE, 0, "series_inductance", "Series inductance", NULL},
238 {SR_MQ_SERIES_CAPACITANCE, 0, "series_capacitance", "Series capacitance", NULL},
239 {SR_MQ_SERIES_RESISTANCE, 0, "series_resistance", "Series resistance", NULL},
240 {SR_MQ_DISSIPATION_FACTOR, 0, "dissipation_factor", "Dissipation factor", NULL},
241 {SR_MQ_QUALITY_FACTOR, 0, "quality_factor", "Quality factor", NULL},
242 {SR_MQ_PHASE_ANGLE, 0, "phase_angle", "Phase angle", NULL},
243 {SR_MQ_DIFFERENCE, 0, "difference", "Difference", NULL},
244 {SR_MQ_COUNT, 0, "count", "Count", NULL},
245 {SR_MQ_POWER_FACTOR, 0, "power_factor", "Power factor", NULL},
246 {SR_MQ_APPARENT_POWER, 0, "apparent_power", "Apparent power", NULL},
247 {SR_MQ_MASS, 0, "mass", "Mass", NULL},
251 /* Please use the same order as in enum sr_mqflag (libsigrok.h). */
252 static struct sr_key_info sr_key_info_mqflag[] = {
253 {SR_MQFLAG_AC, 0, "ac", "AC", NULL},
254 {SR_MQFLAG_DC, 0, "dc", "DC", NULL},
255 {SR_MQFLAG_RMS, 0, "rms", "RMS", NULL},
256 {SR_MQFLAG_DIODE, 0, "diode", "Diode", NULL},
257 {SR_MQFLAG_HOLD, 0, "hold", "Hold", NULL},
258 {SR_MQFLAG_MAX, 0, "max", "Max", NULL},
259 {SR_MQFLAG_MIN, 0, "min", "Min", NULL},
260 {SR_MQFLAG_AUTORANGE, 0, "auto_range", "Auto range", NULL},
261 {SR_MQFLAG_RELATIVE, 0, "relative", "Relative", NULL},
262 {SR_MQFLAG_SPL_FREQ_WEIGHT_A, 0, "spl_freq_weight_a",
263 "Frequency weighted (A)", NULL},
264 {SR_MQFLAG_SPL_FREQ_WEIGHT_C, 0, "spl_freq_weight_c",
265 "Frequency weighted (C)", NULL},
266 {SR_MQFLAG_SPL_FREQ_WEIGHT_Z, 0, "spl_freq_weight_z",
267 "Frequency weighted (Z)", NULL},
268 {SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, 0, "spl_freq_weight_flat",
269 "Frequency weighted (flat)", NULL},
270 {SR_MQFLAG_SPL_TIME_WEIGHT_S, 0, "spl_time_weight_s",
271 "Time weighted (S)", NULL},
272 {SR_MQFLAG_SPL_TIME_WEIGHT_F, 0, "spl_time_weight_f",
273 "Time weighted (F)", NULL},
274 {SR_MQFLAG_SPL_LAT, 0, "spl_time_average", "Time-averaged (LEQ)", NULL},
275 {SR_MQFLAG_SPL_PCT_OVER_ALARM, 0, "spl_pct_over_alarm",
276 "Percentage over alarm", NULL},
277 {SR_MQFLAG_DURATION, 0, "duration", "Duration", NULL},
278 {SR_MQFLAG_AVG, 0, "average", "Average", NULL},
279 {SR_MQFLAG_REFERENCE, 0, "reference", "Reference", NULL},
280 {SR_MQFLAG_UNSTABLE, 0, "unstable", "Unstable", NULL},
281 {SR_MQFLAG_FOUR_WIRE, 0, "four_wire", "4-Wire", NULL},
285 /* This must handle all the keys from enum sr_datatype (libsigrok.h). */
286 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
290 return G_VARIANT_TYPE_INT32;
292 return G_VARIANT_TYPE_UINT64;
294 return G_VARIANT_TYPE_STRING;
296 return G_VARIANT_TYPE_BOOLEAN;
298 return G_VARIANT_TYPE_DOUBLE;
299 case SR_T_RATIONAL_PERIOD:
300 case SR_T_RATIONAL_VOLT:
301 case SR_T_UINT64_RANGE:
302 case SR_T_DOUBLE_RANGE:
303 return G_VARIANT_TYPE_TUPLE;
305 return G_VARIANT_TYPE_DICTIONARY;
307 return G_VARIANT_TYPE_TUPLE;
313 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
315 const struct sr_key_info *info;
316 const GVariantType *type, *expected;
317 char *expected_string, *type_string;
319 info = sr_key_info_get(SR_KEY_CONFIG, key);
323 expected = sr_variant_type_get(info->datatype);
324 type = g_variant_get_type(value);
325 if (!g_variant_type_equal(type, expected)
326 && !g_variant_type_is_subtype_of(type, expected)) {
327 expected_string = g_variant_type_dup_string(expected);
328 type_string = g_variant_type_dup_string(type);
329 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
330 info->name, expected_string, type_string);
331 g_free(expected_string);
340 * Return the list of supported hardware drivers.
342 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
344 * @retval NULL The ctx argument was NULL, or there are no supported drivers.
345 * @retval Other Pointer to the NULL-terminated list of hardware drivers.
346 * The user should NOT g_free() this list, sr_exit() will do that.
350 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
355 return ctx->driver_list;
359 * Initialize a hardware driver.
361 * This usually involves memory allocations and variable initializations
362 * within the driver, but _not_ scanning for attached devices.
363 * The API call sr_driver_scan() is used for that.
365 * @param ctx A libsigrok context object allocated by a previous call to
366 * sr_init(). Must not be NULL.
367 * @param driver The driver to initialize. This must be a pointer to one of
368 * the entries returned by sr_driver_list(). Must not be NULL.
370 * @retval SR_OK Success
371 * @retval SR_ERR_ARG Invalid parameter(s).
372 * @retval SR_ERR_BUG Internal errors.
373 * @retval other Another negative error code upon other errors.
377 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
382 sr_err("Invalid libsigrok context, can't initialize.");
387 sr_err("Invalid driver, can't initialize.");
391 sr_spew("Initializing driver '%s'.", driver->name);
392 if ((ret = driver->init(driver, ctx)) < 0)
393 sr_err("Failed to initialize the driver: %d.", ret);
399 * Enumerate scan options supported by this driver.
401 * Before calling sr_driver_scan_options_list(), the user must have previously
402 * initialized the driver by calling sr_driver_init().
404 * @param driver The driver to enumerate options for. This must be a pointer
405 * to one of the entries returned by sr_driver_list(). Must not
408 * @return A GArray * of uint32_t entries, or NULL on invalid arguments. Each
409 * entry is a configuration key that is supported as a scan option.
410 * The array must be freed by the caller using g_array_free().
414 SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver)
417 const uint32_t *opts;
421 if (sr_config_list(driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, &gvar) != SR_OK)
424 opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
426 result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
428 g_array_insert_vals(result, 0, opts, num_opts);
430 g_variant_unref(gvar);
435 static int check_options(struct sr_dev_driver *driver, GSList *options,
436 uint32_t optlist_key, struct sr_dev_inst *sdi,
437 struct sr_channel_group *cg)
439 struct sr_config *src;
440 const struct sr_key_info *srci;
443 const uint32_t *opts;
447 if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
448 /* Driver publishes no options for this optlist. */
453 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
454 for (l = options; l; l = l->next) {
456 for (i = 0; i < num_opts; i++) {
457 if (opts[i] == src->key)
461 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key)))
462 /* Shouldn't happen. */
463 sr_err("Invalid option %d.", src->key);
465 sr_err("Invalid option '%s'.", srci->id);
469 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
474 g_variant_unref(gvar_opts);
480 * Tell a hardware driver to scan for devices.
482 * In addition to the detection, the devices that are found are also
483 * initialized automatically. On some devices, this involves a firmware upload,
484 * or other such measures.
486 * The order in which the system is scanned for devices is not specified. The
487 * caller should not assume or rely on any specific order.
489 * Before calling sr_driver_scan(), the user must have previously initialized
490 * the driver by calling sr_driver_init().
492 * @param driver The driver that should scan. This must be a pointer to one of
493 * the entries returned by sr_driver_list(). Must not be NULL.
494 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
495 * scanner. Can be NULL/empty.
497 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
498 * found (or errors were encountered). This list must be freed by the
499 * caller using g_slist_free(), but without freeing the data pointed
504 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
509 sr_err("Invalid driver, can't scan for devices.");
513 if (!driver->context) {
514 sr_err("Driver not initialized, can't scan for devices.");
519 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
523 l = driver->scan(driver, options);
525 sr_spew("Scan of '%s' found %d devices.", driver->name,
532 * Call driver cleanup function for all drivers.
534 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
538 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
541 struct sr_dev_driver **drivers;
546 drivers = sr_driver_list(ctx);
547 for (i = 0; drivers[i]; i++) {
548 if (drivers[i]->cleanup)
549 drivers[i]->cleanup(drivers[i]);
550 drivers[i]->context = NULL;
554 /** Allocate struct sr_config.
555 * A floating reference can be passed in for data.
558 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
560 struct sr_config *src;
562 src = g_malloc0(sizeof(struct sr_config));
564 src->data = g_variant_ref_sink(data);
569 /** Free struct sr_config.
572 SR_PRIV void sr_config_free(struct sr_config *src)
575 if (!src || !src->data) {
576 sr_err("%s: invalid data!", __func__);
580 g_variant_unref(src->data);
585 static void log_key(const struct sr_dev_inst *sdi,
586 const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
589 const struct sr_key_info *srci;
592 /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
593 if (key == SR_CONF_DEVICE_OPTIONS)
596 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
597 srci = sr_key_info_get(SR_KEY_CONFIG, key);
599 tmp_str = g_variant_print(data, TRUE);
600 sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
601 srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
602 data ? tmp_str : "NULL");
606 static int check_key(const struct sr_dev_driver *driver,
607 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
608 uint32_t key, int op, GVariant *data)
610 const struct sr_key_info *srci;
613 const uint32_t *opts;
619 suffix = " for this device and channel group";
621 suffix = " for this device";
625 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, key))) {
626 sr_err("Invalid key %d.", key);
629 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
632 case SR_CONF_LIMIT_MSEC:
633 case SR_CONF_LIMIT_SAMPLES:
634 case SR_CONF_SAMPLERATE:
635 /* Setting any of these to 0 is not useful. */
636 if (op != SR_CONF_SET || !data)
638 if (g_variant_get_uint64(data) == 0) {
639 sr_err("Cannot set '%s' to 0.", srci->id);
645 if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
646 /* Driver publishes no options. */
647 sr_err("No options available%s.", suffix);
650 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
652 for (i = 0; i < num_opts; i++) {
653 if ((opts[i] & SR_CONF_MASK) == key) {
658 g_variant_unref(gvar_opts);
660 sr_err("Option '%s' not available%s.", srci->id, suffix);
664 if (!(pub_opt & op)) {
665 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
673 * Query value of a configuration key at the given driver or device instance.
675 * @param[in] driver The sr_dev_driver struct to query.
676 * @param[in] sdi (optional) If the key is specific to a device, this must
677 * contain a pointer to the struct sr_dev_inst to be checked.
678 * Otherwise it must be NULL.
679 * @param[in] cg The channel group on the device for which to list the
681 * @param[in] key The configuration key (SR_CONF_*).
682 * @param[in,out] data Pointer to a GVariant where the value will be stored.
683 * Must not be NULL. The caller is given ownership of the GVariant
684 * and must thus decrease the refcount after use. However if
685 * this function returns an error code, the field should be
686 * considered unused, and should not be unreferenced.
688 * @retval SR_OK Success.
689 * @retval SR_ERR Error.
690 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
691 * interpreted as an error by the caller; merely as an indication
692 * that it's not applicable.
696 SR_API int sr_config_get(const struct sr_dev_driver *driver,
697 const struct sr_dev_inst *sdi,
698 const struct sr_channel_group *cg,
699 uint32_t key, GVariant **data)
703 if (!driver || !data)
706 if (!driver->config_get)
709 if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
712 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
713 log_key(sdi, cg, key, SR_CONF_GET, *data);
714 /* Got a floating reference from the driver. Sink it here,
715 * caller will need to unref when done with it. */
716 g_variant_ref_sink(*data);
723 * Set value of a configuration key in a device instance.
725 * @param[in] sdi The device instance.
726 * @param[in] cg The channel group on the device for which to list the
728 * @param[in] key The configuration key (SR_CONF_*).
729 * @param data The new value for the key, as a GVariant with GVariantType
730 * appropriate to that key. A floating reference can be passed
731 * in; its refcount will be sunk and unreferenced after use.
733 * @retval SR_OK Success.
734 * @retval SR_ERR Error.
735 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
736 * interpreted as an error by the caller; merely as an indication
737 * that it's not applicable.
741 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
742 const struct sr_channel_group *cg,
743 uint32_t key, GVariant *data)
747 g_variant_ref_sink(data);
749 if (!sdi || !sdi->driver || !data)
751 else if (!sdi->driver->config_set)
753 else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
755 else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
756 log_key(sdi, cg, key, SR_CONF_SET, data);
757 ret = sdi->driver->config_set(key, data, sdi, cg);
760 g_variant_unref(data);
766 * Apply configuration settings to the device hardware.
768 * @param sdi The device instance.
770 * @return SR_OK upon success or SR_ERR in case of error.
774 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
778 if (!sdi || !sdi->driver)
780 else if (!sdi->driver->config_commit)
783 ret = sdi->driver->config_commit(sdi);
789 * List all possible values for a configuration key.
791 * @param[in] driver The sr_dev_driver struct to query.
792 * @param[in] sdi (optional) If the key is specific to a device, this must
793 * contain a pointer to the struct sr_dev_inst to be checked.
794 * @param[in] cg The channel group on the device for which to list the
796 * @param[in] key The configuration key (SR_CONF_*).
797 * @param[in,out] data A pointer to a GVariant where the list will be stored.
798 * The caller is given ownership of the GVariant and must thus
799 * unref the GVariant after use. However if this function
800 * returns an error code, the field should be considered
801 * unused, and should not be unreferenced.
803 * @retval SR_OK Success.
804 * @retval SR_ERR Error.
805 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
806 * interpreted as an error by the caller; merely as an indication
807 * that it's not applicable.
811 SR_API int sr_config_list(const struct sr_dev_driver *driver,
812 const struct sr_dev_inst *sdi,
813 const struct sr_channel_group *cg,
814 uint32_t key, GVariant **data)
818 if (!driver || !data)
820 else if (!driver->config_list)
822 else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
823 if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
826 if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
827 log_key(sdi, cg, key, SR_CONF_LIST, *data);
828 g_variant_ref_sink(*data);
834 static struct sr_key_info *get_keytable(int keytype)
836 struct sr_key_info *table;
840 table = sr_key_info_config;
843 table = sr_key_info_mq;
846 table = sr_key_info_mqflag;
849 sr_err("Invalid keytype %d", keytype);
857 * Get information about a key, by key.
859 * @param[in] keytype The namespace the key is in.
860 * @param[in] key The key to find.
862 * @return A pointer to a struct sr_key_info, or NULL if the key
867 SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key)
869 struct sr_key_info *table;
872 if (!(table = get_keytable(keytype)))
875 for (i = 0; table[i].key; i++) {
876 if (table[i].key == key)
884 * Get information about a key, by name.
886 * @param[in] keytype The namespace the key is in.
887 * @param[in] keyid The key id string.
889 * @return A pointer to a struct sr_key_info, or NULL if the key
894 SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid)
896 struct sr_key_info *table;
899 if (!(table = get_keytable(keytype)))
902 for (i = 0; table[i].key; i++) {
905 if (!strcmp(table[i].id, keyid))