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},
65 {SR_CONF_POWERMETER, SR_T_STRING, NULL, "Power meter", NULL},
66 {SR_CONF_MULTIPLEXER, SR_T_STRING, NULL, "Multiplexer", NULL},
68 /* Driver scan options */
69 {SR_CONF_CONN, SR_T_STRING, "conn",
71 {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
72 "Serial communication", NULL},
73 {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr",
74 "Modbus slave address", NULL},
75 {SR_CONF_FORCE_DETECT, SR_T_STRING, "force_detect",
76 "Forced detection", NULL},
77 {SR_CONF_PROBE_NAMES, SR_T_STRING, "probe_names",
78 "Names of device's probes", NULL},
80 /* Device (or channel group) configuration */
81 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
83 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
84 "Pre-trigger capture ratio", NULL},
85 {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
87 {SR_CONF_RLE, SR_T_BOOL, "rle",
88 "Run length encoding", NULL},
89 {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
90 "Trigger slope", NULL},
91 {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
93 {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
94 "Number of samples to average over", NULL},
95 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
96 "Trigger source", NULL},
97 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
98 "Horizontal trigger position", NULL},
99 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
100 "Buffer size", NULL},
101 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
103 {SR_CONF_FILTER, SR_T_BOOL, "filter",
105 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
107 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
109 {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
110 "Trigger matches", NULL},
111 {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
112 "Sample interval", NULL},
113 {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
114 "Number of horizontal divisions", NULL},
115 {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
116 "Number of vertical divisions", NULL},
117 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
118 "Sound pressure level frequency weighting", NULL},
119 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
120 "Sound pressure level time weighting", NULL},
121 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
122 "Sound pressure level measurement range", NULL},
123 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
125 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
127 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
128 "Voltage threshold", NULL },
129 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
130 "External clock mode", NULL},
131 {SR_CONF_SWAP, SR_T_BOOL, "swap",
132 "Swap channel order", NULL},
133 {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
134 "Center frequency", NULL},
135 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
136 "Number of logic channels", NULL},
137 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
138 "Number of analog channels", NULL},
139 {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage",
140 "Current voltage", NULL},
141 {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target",
142 "Voltage target", NULL},
143 {SR_CONF_CURRENT, SR_T_FLOAT, "current",
144 "Current current", NULL},
145 {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit",
146 "Current limit", NULL},
147 {SR_CONF_ENABLED, SR_T_BOOL, "enabled",
148 "Channel enabled", NULL},
149 {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config",
150 "Channel modes", NULL},
151 {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
152 "Over-voltage protection enabled", NULL},
153 {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
154 "Over-voltage protection active", NULL},
155 {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
156 "Over-voltage protection threshold", NULL},
157 {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
158 "Over-current protection enabled", NULL},
159 {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
160 "Over-current protection active", NULL},
161 {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
162 "Over-current protection threshold", NULL},
163 {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
165 {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
167 {SR_CONF_REGULATION, SR_T_STRING, "regulation",
168 "Channel regulation", NULL},
169 {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
170 "Over-temperature protection", NULL},
171 {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency",
172 "Output frequency", NULL},
173 {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
174 "Output frequency target", NULL},
175 {SR_CONF_MEASURED_QUANTITY, SR_T_MQ, "measured_quantity",
176 "Measured quantity", NULL},
177 {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
178 "Equivalent circuit model", NULL},
179 {SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE, SR_T_BOOL, "otp_active",
180 "Over-temperature protection active", NULL},
181 {SR_CONF_UNDER_VOLTAGE_CONDITION, SR_T_BOOL, "uvc",
182 "Under-voltage condition", NULL},
183 {SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE, SR_T_BOOL, "uvc_active",
184 "Under-voltage condition active", NULL},
185 {SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD, SR_T_FLOAT, "uvc_threshold",
186 "Under-voltage condition threshold", NULL},
187 {SR_CONF_TRIGGER_LEVEL, SR_T_FLOAT, "triggerlevel",
188 "Trigger level", NULL},
189 {SR_CONF_EXTERNAL_CLOCK_SOURCE, SR_T_STRING, "external_clock_source",
190 "External clock source", NULL},
191 {SR_CONF_OFFSET, SR_T_FLOAT, "offset",
193 {SR_CONF_TRIGGER_PATTERN, SR_T_STRING, "triggerpattern",
194 "Trigger pattern", NULL},
195 {SR_CONF_HIGH_RESOLUTION, SR_T_BOOL, "highresolution",
196 "High resolution", NULL},
197 {SR_CONF_PEAK_DETECTION, SR_T_BOOL, "peakdetection",
198 "Peak detection", NULL},
199 {SR_CONF_LOGIC_THRESHOLD, SR_T_STRING, "logic_threshold",
200 "Logic threshold (predefined)", NULL},
201 {SR_CONF_LOGIC_THRESHOLD_CUSTOM, SR_T_FLOAT, "logic_threshold_custom",
202 "Logic threshold (custom)", NULL},
203 {SR_CONF_RANGE, SR_T_STRING, "range",
205 {SR_CONF_DIGITS, SR_T_STRING, "digits",
207 {SR_CONF_PHASE, SR_T_FLOAT, "phase",
209 {SR_CONF_DUTY_CYCLE, SR_T_FLOAT, "output_duty_cycle",
211 {SR_CONF_POWER, SR_T_FLOAT, "power",
213 {SR_CONF_POWER_TARGET, SR_T_FLOAT, "power_target",
214 "Power Target", NULL},
215 {SR_CONF_RESISTANCE_TARGET, SR_T_FLOAT, "resistance_target",
216 "Resistance Target", NULL},
219 {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
220 "Session file", NULL},
221 {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile",
222 "Capture file", NULL},
223 {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize",
224 "Capture unitsize", NULL},
225 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
227 {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
228 "Data source", NULL},
229 {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
230 "Probe factor", NULL},
231 {SR_CONF_ADC_POWERLINE_CYCLES, SR_T_FLOAT, "nplc",
232 "Number of ADC powerline cycles", NULL},
234 /* Acquisition modes, sample limiting */
235 {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
237 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
238 "Sample limit", NULL},
239 {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
240 "Frame limit", NULL},
241 {SR_CONF_CONTINUOUS, SR_T_BOOL, "continuous",
242 "Continuous sampling", NULL},
243 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
245 {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
246 "Device mode", NULL},
247 {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
253 /* Please use the same order as in enum sr_mq (libsigrok.h). */
254 static struct sr_key_info sr_key_info_mq[] = {
255 {SR_MQ_VOLTAGE, 0, "voltage", "Voltage", NULL},
256 {SR_MQ_CURRENT, 0, "current", "Current", NULL},
257 {SR_MQ_RESISTANCE, 0, "resistance", "Resistance", NULL},
258 {SR_MQ_CAPACITANCE, 0, "capacitance", "Capacitance", NULL},
259 {SR_MQ_TEMPERATURE, 0, "temperature", "Temperature", NULL},
260 {SR_MQ_FREQUENCY, 0, "frequency", "Frequency", NULL},
261 {SR_MQ_DUTY_CYCLE, 0, "duty_cycle", "Duty cycle", NULL},
262 {SR_MQ_CONTINUITY, 0, "continuity", "Continuity", NULL},
263 {SR_MQ_PULSE_WIDTH, 0, "pulse_width", "Pulse width", NULL},
264 {SR_MQ_CONDUCTANCE, 0, "conductance", "Conductance", NULL},
265 {SR_MQ_POWER, 0, "power", "Power", NULL},
266 {SR_MQ_GAIN, 0, "gain", "Gain", NULL},
267 {SR_MQ_SOUND_PRESSURE_LEVEL, 0, "spl", "Sound pressure level", NULL},
268 {SR_MQ_CARBON_MONOXIDE, 0, "co", "Carbon monoxide", NULL},
269 {SR_MQ_RELATIVE_HUMIDITY, 0, "rh", "Relative humidity", NULL},
270 {SR_MQ_TIME, 0, "time", "Time", NULL},
271 {SR_MQ_WIND_SPEED, 0, "wind_speed", "Wind speed", NULL},
272 {SR_MQ_PRESSURE, 0, "pressure", "Pressure", NULL},
273 {SR_MQ_PARALLEL_INDUCTANCE, 0, "parallel_inductance", "Parallel inductance", NULL},
274 {SR_MQ_PARALLEL_CAPACITANCE, 0, "parallel_capacitance", "Parallel capacitance", NULL},
275 {SR_MQ_PARALLEL_RESISTANCE, 0, "parallel_resistance", "Parallel resistance", NULL},
276 {SR_MQ_SERIES_INDUCTANCE, 0, "series_inductance", "Series inductance", NULL},
277 {SR_MQ_SERIES_CAPACITANCE, 0, "series_capacitance", "Series capacitance", NULL},
278 {SR_MQ_SERIES_RESISTANCE, 0, "series_resistance", "Series resistance", NULL},
279 {SR_MQ_DISSIPATION_FACTOR, 0, "dissipation_factor", "Dissipation factor", NULL},
280 {SR_MQ_QUALITY_FACTOR, 0, "quality_factor", "Quality factor", NULL},
281 {SR_MQ_PHASE_ANGLE, 0, "phase_angle", "Phase angle", NULL},
282 {SR_MQ_DIFFERENCE, 0, "difference", "Difference", NULL},
283 {SR_MQ_COUNT, 0, "count", "Count", NULL},
284 {SR_MQ_POWER_FACTOR, 0, "power_factor", "Power factor", NULL},
285 {SR_MQ_APPARENT_POWER, 0, "apparent_power", "Apparent power", NULL},
286 {SR_MQ_MASS, 0, "mass", "Mass", NULL},
287 {SR_MQ_HARMONIC_RATIO, 0, "harmonic_ratio", "Harmonic ratio", NULL},
288 {SR_MQ_ENERGY, 0, "energy", "Energy", NULL},
289 {SR_MQ_ELECTRIC_CHARGE, 0, "electric_charge", "Electric charge", NULL},
293 /* Please use the same order as in enum sr_mqflag (libsigrok.h). */
294 static struct sr_key_info sr_key_info_mqflag[] = {
295 {SR_MQFLAG_AC, 0, "ac", "AC", NULL},
296 {SR_MQFLAG_DC, 0, "dc", "DC", NULL},
297 {SR_MQFLAG_RMS, 0, "rms", "RMS", NULL},
298 {SR_MQFLAG_DIODE, 0, "diode", "Diode", NULL},
299 {SR_MQFLAG_HOLD, 0, "hold", "Hold", NULL},
300 {SR_MQFLAG_MAX, 0, "max", "Max", NULL},
301 {SR_MQFLAG_MIN, 0, "min", "Min", NULL},
302 {SR_MQFLAG_AUTORANGE, 0, "auto_range", "Auto range", NULL},
303 {SR_MQFLAG_RELATIVE, 0, "relative", "Relative", NULL},
304 {SR_MQFLAG_SPL_FREQ_WEIGHT_A, 0, "spl_freq_weight_a",
305 "Frequency weighted (A)", NULL},
306 {SR_MQFLAG_SPL_FREQ_WEIGHT_C, 0, "spl_freq_weight_c",
307 "Frequency weighted (C)", NULL},
308 {SR_MQFLAG_SPL_FREQ_WEIGHT_Z, 0, "spl_freq_weight_z",
309 "Frequency weighted (Z)", NULL},
310 {SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, 0, "spl_freq_weight_flat",
311 "Frequency weighted (flat)", NULL},
312 {SR_MQFLAG_SPL_TIME_WEIGHT_S, 0, "spl_time_weight_s",
313 "Time weighted (S)", NULL},
314 {SR_MQFLAG_SPL_TIME_WEIGHT_F, 0, "spl_time_weight_f",
315 "Time weighted (F)", NULL},
316 {SR_MQFLAG_SPL_LAT, 0, "spl_time_average", "Time-averaged (LEQ)", NULL},
317 {SR_MQFLAG_SPL_PCT_OVER_ALARM, 0, "spl_pct_over_alarm",
318 "Percentage over alarm", NULL},
319 {SR_MQFLAG_DURATION, 0, "duration", "Duration", NULL},
320 {SR_MQFLAG_AVG, 0, "average", "Average", NULL},
321 {SR_MQFLAG_REFERENCE, 0, "reference", "Reference", NULL},
322 {SR_MQFLAG_UNSTABLE, 0, "unstable", "Unstable", NULL},
323 {SR_MQFLAG_FOUR_WIRE, 0, "four_wire", "4-Wire", NULL},
327 /* This must handle all the keys from enum sr_datatype (libsigrok.h). */
329 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
333 return G_VARIANT_TYPE_INT32;
335 return G_VARIANT_TYPE_UINT32;
337 return G_VARIANT_TYPE_UINT64;
339 return G_VARIANT_TYPE_STRING;
341 return G_VARIANT_TYPE_BOOLEAN;
343 return G_VARIANT_TYPE_DOUBLE;
344 case SR_T_RATIONAL_PERIOD:
345 case SR_T_RATIONAL_VOLT:
346 case SR_T_UINT64_RANGE:
347 case SR_T_DOUBLE_RANGE:
348 return G_VARIANT_TYPE_TUPLE;
350 return G_VARIANT_TYPE_DICTIONARY;
352 return G_VARIANT_TYPE_TUPLE;
359 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
361 const struct sr_key_info *info;
362 const GVariantType *type, *expected;
363 char *expected_string, *type_string;
365 info = sr_key_info_get(SR_KEY_CONFIG, key);
369 expected = sr_variant_type_get(info->datatype);
370 type = g_variant_get_type(value);
371 if (!g_variant_type_equal(type, expected)
372 && !g_variant_type_is_subtype_of(type, expected)) {
373 expected_string = g_variant_type_dup_string(expected);
374 type_string = g_variant_type_dup_string(type);
375 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
376 info->name, expected_string, type_string);
377 g_free(expected_string);
386 * Return the list of supported hardware drivers.
388 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
390 * @retval NULL The ctx argument was NULL, or there are no supported drivers.
391 * @retval Other Pointer to the NULL-terminated list of hardware drivers.
392 * The user should NOT g_free() this list, sr_exit() will do that.
396 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
401 return ctx->driver_list;
405 * Initialize a hardware driver.
407 * This usually involves memory allocations and variable initializations
408 * within the driver, but _not_ scanning for attached devices.
409 * The API call sr_driver_scan() is used for that.
411 * @param ctx A libsigrok context object allocated by a previous call to
412 * sr_init(). Must not be NULL.
413 * @param driver The driver to initialize. This must be a pointer to one of
414 * the entries returned by sr_driver_list(). Must not be NULL.
416 * @retval SR_OK Success
417 * @retval SR_ERR_ARG Invalid parameter(s).
418 * @retval SR_ERR_BUG Internal errors.
419 * @retval other Another negative error code upon other errors.
423 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
428 sr_err("Invalid libsigrok context, can't initialize.");
433 sr_err("Invalid driver, can't initialize.");
437 /* No log message here, too verbose and not very useful. */
439 if ((ret = driver->init(driver, ctx)) < 0)
440 sr_err("Failed to initialize the driver: %d.", ret);
446 * Enumerate scan options supported by this driver.
448 * Before calling sr_driver_scan_options_list(), the user must have previously
449 * initialized the driver by calling sr_driver_init().
451 * @param driver The driver to enumerate options for. This must be a pointer
452 * to one of the entries returned by sr_driver_list(). Must not
455 * @return A GArray * of uint32_t entries, or NULL on invalid arguments. Each
456 * entry is a configuration key that is supported as a scan option.
457 * The array must be freed by the caller using g_array_free().
461 SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver)
464 const uint32_t *opts;
468 if (sr_config_list(driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, &gvar) != SR_OK)
471 opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
473 result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
475 g_array_insert_vals(result, 0, opts, num_opts);
477 g_variant_unref(gvar);
482 static int check_options(struct sr_dev_driver *driver, GSList *options,
483 uint32_t optlist_key, struct sr_dev_inst *sdi,
484 struct sr_channel_group *cg)
486 struct sr_config *src;
487 const struct sr_key_info *srci;
490 const uint32_t *opts;
494 if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
495 /* Driver publishes no options for this optlist. */
500 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
501 for (l = options; l; l = l->next) {
503 for (i = 0; i < num_opts; i++) {
504 if (opts[i] == src->key)
508 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key)))
509 /* Shouldn't happen. */
510 sr_err("Invalid option %d.", src->key);
512 sr_err("Invalid option '%s'.", srci->id);
516 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
521 g_variant_unref(gvar_opts);
527 * Tell a hardware driver to scan for devices.
529 * In addition to the detection, the devices that are found are also
530 * initialized automatically. On some devices, this involves a firmware upload,
531 * or other such measures.
533 * The order in which the system is scanned for devices is not specified. The
534 * caller should not assume or rely on any specific order.
536 * Before calling sr_driver_scan(), the user must have previously initialized
537 * the driver by calling sr_driver_init().
539 * @param driver The driver that should scan. This must be a pointer to one of
540 * the entries returned by sr_driver_list(). Must not be NULL.
541 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
542 * scanner. Can be NULL/empty.
544 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
545 * found (or errors were encountered). This list must be freed by the
546 * caller using g_slist_free(), but without freeing the data pointed
551 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
556 sr_err("Invalid driver, can't scan for devices.");
560 if (!driver->context) {
561 sr_err("Driver not initialized, can't scan for devices.");
566 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
570 l = driver->scan(driver, options);
572 sr_spew("Scan found %d devices (%s).", g_slist_length(l), driver->name);
578 * Call driver cleanup function for all drivers.
580 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
584 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
587 struct sr_dev_driver **drivers;
592 sr_dbg("Cleaning up all drivers.");
594 drivers = sr_driver_list(ctx);
595 for (i = 0; drivers[i]; i++) {
596 if (drivers[i]->cleanup)
597 drivers[i]->cleanup(drivers[i]);
598 drivers[i]->context = NULL;
603 * Allocate struct sr_config.
605 * A floating reference can be passed in for data.
607 * @param key The config key to use.
608 * @param data The GVariant data to use.
610 * @return The newly allocated struct sr_config. This function is assumed
615 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
617 struct sr_config *src;
619 src = g_malloc0(sizeof(struct sr_config));
621 src->data = g_variant_ref_sink(data);
627 * Free struct sr_config.
631 SR_PRIV void sr_config_free(struct sr_config *src)
633 if (!src || !src->data) {
634 sr_err("%s: invalid data!", __func__);
638 g_variant_unref(src->data);
643 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi)
645 if (!sdi || !sdi->driver) {
646 sr_err("%s: Invalid arguments.", __func__);
650 if (sdi->status != SR_ST_ACTIVE) {
651 sr_err("%s: Device instance not active, can't start.",
653 return SR_ERR_DEV_CLOSED;
656 sr_dbg("%s: Starting acquisition.", sdi->driver->name);
658 return sdi->driver->dev_acquisition_start(sdi);
662 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi)
664 if (!sdi || !sdi->driver) {
665 sr_err("%s: Invalid arguments.", __func__);
669 if (sdi->status != SR_ST_ACTIVE) {
670 sr_err("%s: Device instance not active, can't stop.",
672 return SR_ERR_DEV_CLOSED;
675 sr_dbg("%s: Stopping acquisition.", sdi->driver->name);
677 return sdi->driver->dev_acquisition_stop(sdi);
680 static void log_key(const struct sr_dev_inst *sdi,
681 const struct sr_channel_group *cg, uint32_t key, unsigned int op,
685 const struct sr_key_info *srci;
688 /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
689 if (key == SR_CONF_DEVICE_OPTIONS)
692 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
693 srci = sr_key_info_get(SR_KEY_CONFIG, key);
695 tmp_str = g_variant_print(data, TRUE);
696 sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
697 srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
698 data ? tmp_str : "NULL");
702 static int check_key(const struct sr_dev_driver *driver,
703 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
704 uint32_t key, unsigned int op, GVariant *data)
706 const struct sr_key_info *srci;
709 const uint32_t *opts;
715 suffix = " for this device instance and channel group";
717 suffix = " for this device instance";
721 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, key))) {
722 sr_err("Invalid key %d.", key);
725 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
728 case SR_CONF_LIMIT_MSEC:
729 case SR_CONF_LIMIT_SAMPLES:
730 case SR_CONF_SAMPLERATE:
731 /* Setting any of these to 0 is not useful. */
732 if (op != SR_CONF_SET || !data)
734 if (g_variant_get_uint64(data) == 0) {
735 sr_err("Cannot set '%s' to 0.", srci->id);
739 case SR_CONF_CAPTURE_RATIO:
740 /* Capture ratio must always be between 0 and 100. */
741 if (op != SR_CONF_SET || !data)
743 if (g_variant_get_uint64(data) > 100) {
744 sr_err("Capture ratio must be 0..100.");
750 if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
751 /* Driver publishes no options. */
752 sr_err("No options available%s.", suffix);
755 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
757 for (i = 0; i < num_opts; i++) {
758 if ((opts[i] & SR_CONF_MASK) == key) {
763 g_variant_unref(gvar_opts);
765 sr_err("Option '%s' not available%s.", srci->id, suffix);
769 if (!(pub_opt & op)) {
770 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
778 * Query value of a configuration key at the given driver or device instance.
780 * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
781 * @param[in] sdi (optional) If the key is specific to a device, this must
782 * contain a pointer to the struct sr_dev_inst to be checked.
783 * Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
785 * @param[in] cg The channel group on the device for which to list the
787 * @param[in] key The configuration key (SR_CONF_*).
788 * @param[in,out] data Pointer to a GVariant where the value will be stored.
789 * Must not be NULL. The caller is given ownership of the GVariant
790 * and must thus decrease the refcount after use. However if
791 * this function returns an error code, the field should be
792 * considered unused, and should not be unreferenced.
794 * @retval SR_OK Success.
795 * @retval SR_ERR Error.
796 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
797 * interpreted as an error by the caller; merely as an indication
798 * that it's not applicable.
802 SR_API int sr_config_get(const struct sr_dev_driver *driver,
803 const struct sr_dev_inst *sdi,
804 const struct sr_channel_group *cg,
805 uint32_t key, GVariant **data)
809 if (!driver || !data)
812 if (!driver->config_get)
815 if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
818 if (sdi && !sdi->priv) {
819 sr_err("Can't get config (sdi != NULL, sdi->priv == NULL).");
823 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
824 log_key(sdi, cg, key, SR_CONF_GET, *data);
825 /* Got a floating reference from the driver. Sink it here,
826 * caller will need to unref when done with it. */
827 g_variant_ref_sink(*data);
830 if (ret == SR_ERR_CHANNEL_GROUP)
831 sr_err("%s: No channel group specified.",
832 (sdi) ? sdi->driver->name : "unknown");
838 * Set value of a configuration key in a device instance.
840 * @param[in] sdi The device instance. Must not be NULL. sdi->driver and
841 * sdi->priv must not be NULL either.
842 * @param[in] cg The channel group on the device for which to list the
844 * @param[in] key The configuration key (SR_CONF_*).
845 * @param data The new value for the key, as a GVariant with GVariantType
846 * appropriate to that key. A floating reference can be passed
847 * in; its refcount will be sunk and unreferenced after use.
849 * @retval SR_OK Success.
850 * @retval SR_ERR Error.
851 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
852 * interpreted as an error by the caller; merely as an indication
853 * that it's not applicable.
857 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
858 const struct sr_channel_group *cg,
859 uint32_t key, GVariant *data)
863 g_variant_ref_sink(data);
865 if (!sdi || !sdi->driver || !sdi->priv || !data)
867 else if (!sdi->driver->config_set)
869 else if (sdi->status != SR_ST_ACTIVE) {
870 sr_err("%s: Device instance not active, can't set config.",
872 ret = SR_ERR_DEV_CLOSED;
873 } else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
875 else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
876 log_key(sdi, cg, key, SR_CONF_SET, data);
877 ret = sdi->driver->config_set(key, data, sdi, cg);
880 g_variant_unref(data);
882 if (ret == SR_ERR_CHANNEL_GROUP)
883 sr_err("%s: No channel group specified.",
884 (sdi) ? sdi->driver->name : "unknown");
890 * Apply configuration settings to the device hardware.
892 * @param sdi The device instance.
894 * @return SR_OK upon success or SR_ERR in case of error.
898 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
902 if (!sdi || !sdi->driver)
904 else if (!sdi->driver->config_commit)
906 else if (sdi->status != SR_ST_ACTIVE) {
907 sr_err("%s: Device instance not active, can't commit config.",
909 ret = SR_ERR_DEV_CLOSED;
911 ret = sdi->driver->config_commit(sdi);
917 * List all possible values for a configuration key.
919 * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
920 * @param[in] sdi (optional) If the key is specific to a device instance, this
921 * must contain a pointer to the struct sr_dev_inst to be checked.
922 * Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
924 * @param[in] cg The channel group on the device instance for which to list
925 * the values, or NULL. If this device instance doesn't
926 * have channel groups, this must not be != NULL.
927 * If cg is NULL, this function will return the "common" device
928 * instance options that are channel-group independent. Otherwise
929 * it will return the channel-group specific options.
930 * @param[in] key The configuration key (SR_CONF_*).
931 * @param[in,out] data A pointer to a GVariant where the list will be stored.
932 * The caller is given ownership of the GVariant and must thus
933 * unref the GVariant after use. However if this function
934 * returns an error code, the field should be considered
935 * unused, and should not be unreferenced.
937 * @retval SR_OK Success.
938 * @retval SR_ERR Error.
939 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
940 * interpreted as an error by the caller; merely as an indication
941 * that it's not applicable.
945 SR_API int sr_config_list(const struct sr_dev_driver *driver,
946 const struct sr_dev_inst *sdi,
947 const struct sr_channel_group *cg,
948 uint32_t key, GVariant **data)
952 if (!driver || !data)
955 if (!driver->config_list)
958 if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
959 if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
963 if (sdi && !sdi->priv) {
964 sr_err("Can't list config (sdi != NULL, sdi->priv == NULL).");
968 if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS && !sdi) {
969 sr_err("Config keys other than SR_CONF_SCAN_OPTIONS and "
970 "SR_CONF_DEVICE_OPTIONS always need an sdi.");
974 if (cg && sdi && !sdi->channel_groups) {
975 sr_err("Can't list config for channel group, there are none.");
979 if (cg && sdi && !g_slist_find(sdi->channel_groups, cg)) {
980 sr_err("If a channel group is specified, it must be a valid one.");
985 sr_err("Need sdi when a channel group is specified.");
989 if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
990 log_key(sdi, cg, key, SR_CONF_LIST, *data);
991 g_variant_ref_sink(*data);
994 if (ret == SR_ERR_CHANNEL_GROUP)
995 sr_err("%s: No channel group specified.",
996 (sdi) ? sdi->driver->name : "unknown");
1001 static struct sr_key_info *get_keytable(int keytype)
1003 struct sr_key_info *table;
1007 table = sr_key_info_config;
1010 table = sr_key_info_mq;
1012 case SR_KEY_MQFLAGS:
1013 table = sr_key_info_mqflag;
1016 sr_err("Invalid keytype %d", keytype);
1024 * Get information about a key, by key.
1026 * @param[in] keytype The namespace the key is in.
1027 * @param[in] key The key to find.
1029 * @return A pointer to a struct sr_key_info, or NULL if the key
1034 SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key)
1036 struct sr_key_info *table;
1039 if (!(table = get_keytable(keytype)))
1042 for (i = 0; table[i].key; i++) {
1043 if (table[i].key == key)
1051 * Get information about a key, by name.
1053 * @param[in] keytype The namespace the key is in.
1054 * @param[in] keyid The key id string.
1056 * @return A pointer to a struct sr_key_info, or NULL if the key
1061 SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid)
1063 struct sr_key_info *table;
1066 if (!(table = get_keytable(keytype)))
1069 for (i = 0; table[i].key; i++) {
1072 if (!strcmp(table[i].id, keyid))