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},
78 /* Device (or channel group) configuration */
79 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
81 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
82 "Pre-trigger capture ratio", NULL},
83 {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
85 {SR_CONF_RLE, SR_T_BOOL, "rle",
86 "Run length encoding", NULL},
87 {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
88 "Trigger slope", NULL},
89 {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
91 {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
92 "Number of samples to average over", NULL},
93 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
94 "Trigger source", NULL},
95 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
96 "Horizontal trigger position", NULL},
97 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
99 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
101 {SR_CONF_FILTER, SR_T_BOOL, "filter",
103 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
105 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
107 {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
108 "Trigger matches", NULL},
109 {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
110 "Sample interval", NULL},
111 {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
112 "Number of horizontal divisions", NULL},
113 {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
114 "Number of vertical divisions", NULL},
115 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
116 "Sound pressure level frequency weighting", NULL},
117 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
118 "Sound pressure level time weighting", NULL},
119 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
120 "Sound pressure level measurement range", NULL},
121 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
123 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
125 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
126 "Voltage threshold", NULL },
127 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
128 "External clock mode", NULL},
129 {SR_CONF_SWAP, SR_T_BOOL, "swap",
130 "Swap channel order", NULL},
131 {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
132 "Center frequency", NULL},
133 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
134 "Number of logic channels", NULL},
135 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
136 "Number of analog channels", NULL},
137 {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage",
138 "Current voltage", NULL},
139 {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target",
140 "Voltage target", NULL},
141 {SR_CONF_CURRENT, SR_T_FLOAT, "current",
142 "Current current", NULL},
143 {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit",
144 "Current limit", NULL},
145 {SR_CONF_ENABLED, SR_T_BOOL, "enabled",
146 "Channel enabled", NULL},
147 {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config",
148 "Channel modes", NULL},
149 {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
150 "Over-voltage protection enabled", NULL},
151 {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
152 "Over-voltage protection active", NULL},
153 {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
154 "Over-voltage protection threshold", NULL},
155 {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
156 "Over-current protection enabled", NULL},
157 {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
158 "Over-current protection active", NULL},
159 {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
160 "Over-current protection threshold", NULL},
161 {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
163 {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
165 {SR_CONF_REGULATION, SR_T_STRING, "regulation",
166 "Channel regulation", NULL},
167 {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
168 "Over-temperature protection", NULL},
169 {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency",
170 "Output frequency", NULL},
171 {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
172 "Output frequency target", NULL},
173 {SR_CONF_MEASURED_QUANTITY, SR_T_MQ, "measured_quantity",
174 "Measured quantity", NULL},
175 {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
176 "Equivalent circuit model", NULL},
177 {SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE, SR_T_BOOL, "otp_active",
178 "Over-temperature protection active", NULL},
179 {SR_CONF_UNDER_VOLTAGE_CONDITION, SR_T_BOOL, "uvc",
180 "Under-voltage condition", NULL},
181 {SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE, SR_T_BOOL, "uvc_active",
182 "Under-voltage condition active", NULL},
183 {SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD, SR_T_FLOAT, "uvc_threshold",
184 "Under-voltage condition threshold", NULL},
185 {SR_CONF_TRIGGER_LEVEL, SR_T_FLOAT, "triggerlevel",
186 "Trigger level", NULL},
187 {SR_CONF_EXTERNAL_CLOCK_SOURCE, SR_T_STRING, "external_clock_source",
188 "External clock source", NULL},
189 {SR_CONF_OFFSET, SR_T_FLOAT, "offset",
191 {SR_CONF_TRIGGER_PATTERN, SR_T_STRING, "triggerpattern",
192 "Trigger pattern", NULL},
193 {SR_CONF_HIGH_RESOLUTION, SR_T_BOOL, "highresolution",
194 "High resolution", NULL},
195 {SR_CONF_PEAK_DETECTION, SR_T_BOOL, "peakdetection",
196 "Peak detection", NULL},
197 {SR_CONF_LOGIC_THRESHOLD, SR_T_STRING, "logic_threshold",
198 "Logic threshold (predefined)", NULL},
199 {SR_CONF_LOGIC_THRESHOLD_CUSTOM, SR_T_FLOAT, "logic_threshold_custom",
200 "Logic threshold (custom)", NULL},
201 {SR_CONF_RANGE, SR_T_STRING, "range",
203 {SR_CONF_DIGITS, SR_T_STRING, "digits",
205 {SR_CONF_PHASE, SR_T_FLOAT, "phase",
207 {SR_CONF_DUTY_CYCLE, SR_T_FLOAT, "output_duty_cycle",
209 {SR_CONF_POWER, SR_T_FLOAT, "power",
211 {SR_CONF_POWER_TARGET, SR_T_FLOAT, "power_target",
212 "Power Target", NULL},
213 {SR_CONF_RESISTANCE_TARGET, SR_T_FLOAT, "resistance_target",
214 "Resistance Target", NULL},
217 {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
218 "Session file", NULL},
219 {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile",
220 "Capture file", NULL},
221 {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize",
222 "Capture unitsize", NULL},
223 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
225 {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
226 "Data source", NULL},
227 {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
228 "Probe factor", NULL},
229 {SR_CONF_ADC_POWERLINE_CYCLES, SR_T_FLOAT, "nplc",
230 "Number of ADC powerline cycles", NULL},
232 /* Acquisition modes, sample limiting */
233 {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
235 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
236 "Sample limit", NULL},
237 {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
238 "Frame limit", NULL},
239 {SR_CONF_CONTINUOUS, SR_T_BOOL, "continuous",
240 "Continuous sampling", NULL},
241 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
243 {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
244 "Device mode", NULL},
245 {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
251 /* Please use the same order as in enum sr_mq (libsigrok.h). */
252 static struct sr_key_info sr_key_info_mq[] = {
253 {SR_MQ_VOLTAGE, 0, "voltage", "Voltage", NULL},
254 {SR_MQ_CURRENT, 0, "current", "Current", NULL},
255 {SR_MQ_RESISTANCE, 0, "resistance", "Resistance", NULL},
256 {SR_MQ_CAPACITANCE, 0, "capacitance", "Capacitance", NULL},
257 {SR_MQ_TEMPERATURE, 0, "temperature", "Temperature", NULL},
258 {SR_MQ_FREQUENCY, 0, "frequency", "Frequency", NULL},
259 {SR_MQ_DUTY_CYCLE, 0, "duty_cycle", "Duty cycle", NULL},
260 {SR_MQ_CONTINUITY, 0, "continuity", "Continuity", NULL},
261 {SR_MQ_PULSE_WIDTH, 0, "pulse_width", "Pulse width", NULL},
262 {SR_MQ_CONDUCTANCE, 0, "conductance", "Conductance", NULL},
263 {SR_MQ_POWER, 0, "power", "Power", NULL},
264 {SR_MQ_GAIN, 0, "gain", "Gain", NULL},
265 {SR_MQ_SOUND_PRESSURE_LEVEL, 0, "spl", "Sound pressure level", NULL},
266 {SR_MQ_CARBON_MONOXIDE, 0, "co", "Carbon monoxide", NULL},
267 {SR_MQ_RELATIVE_HUMIDITY, 0, "rh", "Relative humidity", NULL},
268 {SR_MQ_TIME, 0, "time", "Time", NULL},
269 {SR_MQ_WIND_SPEED, 0, "wind_speed", "Wind speed", NULL},
270 {SR_MQ_PRESSURE, 0, "pressure", "Pressure", NULL},
271 {SR_MQ_PARALLEL_INDUCTANCE, 0, "parallel_inductance", "Parallel inductance", NULL},
272 {SR_MQ_PARALLEL_CAPACITANCE, 0, "parallel_capacitance", "Parallel capacitance", NULL},
273 {SR_MQ_PARALLEL_RESISTANCE, 0, "parallel_resistance", "Parallel resistance", NULL},
274 {SR_MQ_SERIES_INDUCTANCE, 0, "series_inductance", "Series inductance", NULL},
275 {SR_MQ_SERIES_CAPACITANCE, 0, "series_capacitance", "Series capacitance", NULL},
276 {SR_MQ_SERIES_RESISTANCE, 0, "series_resistance", "Series resistance", NULL},
277 {SR_MQ_DISSIPATION_FACTOR, 0, "dissipation_factor", "Dissipation factor", NULL},
278 {SR_MQ_QUALITY_FACTOR, 0, "quality_factor", "Quality factor", NULL},
279 {SR_MQ_PHASE_ANGLE, 0, "phase_angle", "Phase angle", NULL},
280 {SR_MQ_DIFFERENCE, 0, "difference", "Difference", NULL},
281 {SR_MQ_COUNT, 0, "count", "Count", NULL},
282 {SR_MQ_POWER_FACTOR, 0, "power_factor", "Power factor", NULL},
283 {SR_MQ_APPARENT_POWER, 0, "apparent_power", "Apparent power", NULL},
284 {SR_MQ_MASS, 0, "mass", "Mass", NULL},
285 {SR_MQ_HARMONIC_RATIO, 0, "harmonic_ratio", "Harmonic ratio", NULL},
286 {SR_MQ_ENERGY, 0, "energy", "Energy", NULL},
287 {SR_MQ_ELECTRIC_CHARGE, 0, "electric_charge", "Electric charge", NULL},
291 /* Please use the same order as in enum sr_mqflag (libsigrok.h). */
292 static struct sr_key_info sr_key_info_mqflag[] = {
293 {SR_MQFLAG_AC, 0, "ac", "AC", NULL},
294 {SR_MQFLAG_DC, 0, "dc", "DC", NULL},
295 {SR_MQFLAG_RMS, 0, "rms", "RMS", NULL},
296 {SR_MQFLAG_DIODE, 0, "diode", "Diode", NULL},
297 {SR_MQFLAG_HOLD, 0, "hold", "Hold", NULL},
298 {SR_MQFLAG_MAX, 0, "max", "Max", NULL},
299 {SR_MQFLAG_MIN, 0, "min", "Min", NULL},
300 {SR_MQFLAG_AUTORANGE, 0, "auto_range", "Auto range", NULL},
301 {SR_MQFLAG_RELATIVE, 0, "relative", "Relative", NULL},
302 {SR_MQFLAG_SPL_FREQ_WEIGHT_A, 0, "spl_freq_weight_a",
303 "Frequency weighted (A)", NULL},
304 {SR_MQFLAG_SPL_FREQ_WEIGHT_C, 0, "spl_freq_weight_c",
305 "Frequency weighted (C)", NULL},
306 {SR_MQFLAG_SPL_FREQ_WEIGHT_Z, 0, "spl_freq_weight_z",
307 "Frequency weighted (Z)", NULL},
308 {SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, 0, "spl_freq_weight_flat",
309 "Frequency weighted (flat)", NULL},
310 {SR_MQFLAG_SPL_TIME_WEIGHT_S, 0, "spl_time_weight_s",
311 "Time weighted (S)", NULL},
312 {SR_MQFLAG_SPL_TIME_WEIGHT_F, 0, "spl_time_weight_f",
313 "Time weighted (F)", NULL},
314 {SR_MQFLAG_SPL_LAT, 0, "spl_time_average", "Time-averaged (LEQ)", NULL},
315 {SR_MQFLAG_SPL_PCT_OVER_ALARM, 0, "spl_pct_over_alarm",
316 "Percentage over alarm", NULL},
317 {SR_MQFLAG_DURATION, 0, "duration", "Duration", NULL},
318 {SR_MQFLAG_AVG, 0, "average", "Average", NULL},
319 {SR_MQFLAG_REFERENCE, 0, "reference", "Reference", NULL},
320 {SR_MQFLAG_UNSTABLE, 0, "unstable", "Unstable", NULL},
321 {SR_MQFLAG_FOUR_WIRE, 0, "four_wire", "4-Wire", NULL},
325 /* This must handle all the keys from enum sr_datatype (libsigrok.h). */
327 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
331 return G_VARIANT_TYPE_INT32;
333 return G_VARIANT_TYPE_UINT64;
335 return G_VARIANT_TYPE_STRING;
337 return G_VARIANT_TYPE_BOOLEAN;
339 return G_VARIANT_TYPE_DOUBLE;
340 case SR_T_RATIONAL_PERIOD:
341 case SR_T_RATIONAL_VOLT:
342 case SR_T_UINT64_RANGE:
343 case SR_T_DOUBLE_RANGE:
344 return G_VARIANT_TYPE_TUPLE;
346 return G_VARIANT_TYPE_DICTIONARY;
348 return G_VARIANT_TYPE_TUPLE;
355 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
357 const struct sr_key_info *info;
358 const GVariantType *type, *expected;
359 char *expected_string, *type_string;
361 info = sr_key_info_get(SR_KEY_CONFIG, key);
365 expected = sr_variant_type_get(info->datatype);
366 type = g_variant_get_type(value);
367 if (!g_variant_type_equal(type, expected)
368 && !g_variant_type_is_subtype_of(type, expected)) {
369 expected_string = g_variant_type_dup_string(expected);
370 type_string = g_variant_type_dup_string(type);
371 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
372 info->name, expected_string, type_string);
373 g_free(expected_string);
382 * Return the list of supported hardware drivers.
384 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
386 * @retval NULL The ctx argument was NULL, or there are no supported drivers.
387 * @retval Other Pointer to the NULL-terminated list of hardware drivers.
388 * The user should NOT g_free() this list, sr_exit() will do that.
392 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
397 return ctx->driver_list;
401 * Initialize a hardware driver.
403 * This usually involves memory allocations and variable initializations
404 * within the driver, but _not_ scanning for attached devices.
405 * The API call sr_driver_scan() is used for that.
407 * @param ctx A libsigrok context object allocated by a previous call to
408 * sr_init(). Must not be NULL.
409 * @param driver The driver to initialize. This must be a pointer to one of
410 * the entries returned by sr_driver_list(). Must not be NULL.
412 * @retval SR_OK Success
413 * @retval SR_ERR_ARG Invalid parameter(s).
414 * @retval SR_ERR_BUG Internal errors.
415 * @retval other Another negative error code upon other errors.
419 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
424 sr_err("Invalid libsigrok context, can't initialize.");
429 sr_err("Invalid driver, can't initialize.");
433 /* No log message here, too verbose and not very useful. */
435 if ((ret = driver->init(driver, ctx)) < 0)
436 sr_err("Failed to initialize the driver: %d.", ret);
442 * Enumerate scan options supported by this driver.
444 * Before calling sr_driver_scan_options_list(), the user must have previously
445 * initialized the driver by calling sr_driver_init().
447 * @param driver The driver to enumerate options for. This must be a pointer
448 * to one of the entries returned by sr_driver_list(). Must not
451 * @return A GArray * of uint32_t entries, or NULL on invalid arguments. Each
452 * entry is a configuration key that is supported as a scan option.
453 * The array must be freed by the caller using g_array_free().
457 SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver)
460 const uint32_t *opts;
464 if (sr_config_list(driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, &gvar) != SR_OK)
467 opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
469 result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
471 g_array_insert_vals(result, 0, opts, num_opts);
473 g_variant_unref(gvar);
478 static int check_options(struct sr_dev_driver *driver, GSList *options,
479 uint32_t optlist_key, struct sr_dev_inst *sdi,
480 struct sr_channel_group *cg)
482 struct sr_config *src;
483 const struct sr_key_info *srci;
486 const uint32_t *opts;
490 if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
491 /* Driver publishes no options for this optlist. */
496 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
497 for (l = options; l; l = l->next) {
499 for (i = 0; i < num_opts; i++) {
500 if (opts[i] == src->key)
504 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key)))
505 /* Shouldn't happen. */
506 sr_err("Invalid option %d.", src->key);
508 sr_err("Invalid option '%s'.", srci->id);
512 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
517 g_variant_unref(gvar_opts);
523 * Tell a hardware driver to scan for devices.
525 * In addition to the detection, the devices that are found are also
526 * initialized automatically. On some devices, this involves a firmware upload,
527 * or other such measures.
529 * The order in which the system is scanned for devices is not specified. The
530 * caller should not assume or rely on any specific order.
532 * Before calling sr_driver_scan(), the user must have previously initialized
533 * the driver by calling sr_driver_init().
535 * @param driver The driver that should scan. This must be a pointer to one of
536 * the entries returned by sr_driver_list(). Must not be NULL.
537 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
538 * scanner. Can be NULL/empty.
540 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
541 * found (or errors were encountered). This list must be freed by the
542 * caller using g_slist_free(), but without freeing the data pointed
547 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
552 sr_err("Invalid driver, can't scan for devices.");
556 if (!driver->context) {
557 sr_err("Driver not initialized, can't scan for devices.");
562 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
566 l = driver->scan(driver, options);
568 sr_spew("Scan found %d devices (%s).", g_slist_length(l), driver->name);
574 * Call driver cleanup function for all drivers.
576 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
580 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
583 struct sr_dev_driver **drivers;
588 sr_dbg("Cleaning up all drivers.");
590 drivers = sr_driver_list(ctx);
591 for (i = 0; drivers[i]; i++) {
592 if (drivers[i]->cleanup)
593 drivers[i]->cleanup(drivers[i]);
594 drivers[i]->context = NULL;
599 * Allocate struct sr_config.
601 * A floating reference can be passed in for data.
603 * @param key The config key to use.
604 * @param data The GVariant data to use.
606 * @return The newly allocated struct sr_config. This function is assumed
611 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
613 struct sr_config *src;
615 src = g_malloc0(sizeof(struct sr_config));
617 src->data = g_variant_ref_sink(data);
623 * Free struct sr_config.
627 SR_PRIV void sr_config_free(struct sr_config *src)
629 if (!src || !src->data) {
630 sr_err("%s: invalid data!", __func__);
634 g_variant_unref(src->data);
639 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi)
641 if (!sdi || !sdi->driver) {
642 sr_err("%s: Invalid arguments.", __func__);
646 if (sdi->status != SR_ST_ACTIVE) {
647 sr_err("%s: Device instance not active, can't start.",
649 return SR_ERR_DEV_CLOSED;
652 sr_dbg("%s: Starting acquisition.", sdi->driver->name);
654 return sdi->driver->dev_acquisition_start(sdi);
658 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi)
660 if (!sdi || !sdi->driver) {
661 sr_err("%s: Invalid arguments.", __func__);
665 if (sdi->status != SR_ST_ACTIVE) {
666 sr_err("%s: Device instance not active, can't stop.",
668 return SR_ERR_DEV_CLOSED;
671 sr_dbg("%s: Stopping acquisition.", sdi->driver->name);
673 return sdi->driver->dev_acquisition_stop(sdi);
676 static void log_key(const struct sr_dev_inst *sdi,
677 const struct sr_channel_group *cg, uint32_t key, unsigned int op,
681 const struct sr_key_info *srci;
684 /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
685 if (key == SR_CONF_DEVICE_OPTIONS)
688 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
689 srci = sr_key_info_get(SR_KEY_CONFIG, key);
691 tmp_str = g_variant_print(data, TRUE);
692 sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
693 srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
694 data ? tmp_str : "NULL");
698 static int check_key(const struct sr_dev_driver *driver,
699 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
700 uint32_t key, unsigned int op, GVariant *data)
702 const struct sr_key_info *srci;
705 const uint32_t *opts;
711 suffix = " for this device instance and channel group";
713 suffix = " for this device instance";
717 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, key))) {
718 sr_err("Invalid key %d.", key);
721 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
724 case SR_CONF_LIMIT_MSEC:
725 case SR_CONF_LIMIT_SAMPLES:
726 case SR_CONF_SAMPLERATE:
727 /* Setting any of these to 0 is not useful. */
728 if (op != SR_CONF_SET || !data)
730 if (g_variant_get_uint64(data) == 0) {
731 sr_err("Cannot set '%s' to 0.", srci->id);
735 case SR_CONF_CAPTURE_RATIO:
736 /* Capture ratio must always be between 0 and 100. */
737 if (op != SR_CONF_SET || !data)
739 if (g_variant_get_uint64(data) > 100) {
740 sr_err("Capture ratio must be 0..100.");
746 if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
747 /* Driver publishes no options. */
748 sr_err("No options available%s.", suffix);
751 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
753 for (i = 0; i < num_opts; i++) {
754 if ((opts[i] & SR_CONF_MASK) == key) {
759 g_variant_unref(gvar_opts);
761 sr_err("Option '%s' not available%s.", srci->id, suffix);
765 if (!(pub_opt & op)) {
766 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
774 * Query value of a configuration key at the given driver or device instance.
776 * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
777 * @param[in] sdi (optional) If the key is specific to a device, this must
778 * contain a pointer to the struct sr_dev_inst to be checked.
779 * Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
781 * @param[in] cg The channel group on the device for which to list the
783 * @param[in] key The configuration key (SR_CONF_*).
784 * @param[in,out] data Pointer to a GVariant where the value will be stored.
785 * Must not be NULL. The caller is given ownership of the GVariant
786 * and must thus decrease the refcount after use. However if
787 * this function returns an error code, the field should be
788 * considered unused, and should not be unreferenced.
790 * @retval SR_OK Success.
791 * @retval SR_ERR Error.
792 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
793 * interpreted as an error by the caller; merely as an indication
794 * that it's not applicable.
798 SR_API int sr_config_get(const struct sr_dev_driver *driver,
799 const struct sr_dev_inst *sdi,
800 const struct sr_channel_group *cg,
801 uint32_t key, GVariant **data)
805 if (!driver || !data)
808 if (!driver->config_get)
811 if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
814 if (sdi && !sdi->priv) {
815 sr_err("Can't get config (sdi != NULL, sdi->priv == NULL).");
819 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
820 log_key(sdi, cg, key, SR_CONF_GET, *data);
821 /* Got a floating reference from the driver. Sink it here,
822 * caller will need to unref when done with it. */
823 g_variant_ref_sink(*data);
826 if (ret == SR_ERR_CHANNEL_GROUP)
827 sr_err("%s: No channel group specified.",
828 (sdi) ? sdi->driver->name : "unknown");
834 * Set value of a configuration key in a device instance.
836 * @param[in] sdi The device instance. Must not be NULL. sdi->driver and
837 * sdi->priv must not be NULL either.
838 * @param[in] cg The channel group on the device for which to list the
840 * @param[in] key The configuration key (SR_CONF_*).
841 * @param data The new value for the key, as a GVariant with GVariantType
842 * appropriate to that key. A floating reference can be passed
843 * in; its refcount will be sunk and unreferenced after use.
845 * @retval SR_OK Success.
846 * @retval SR_ERR Error.
847 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
848 * interpreted as an error by the caller; merely as an indication
849 * that it's not applicable.
853 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
854 const struct sr_channel_group *cg,
855 uint32_t key, GVariant *data)
859 g_variant_ref_sink(data);
861 if (!sdi || !sdi->driver || !sdi->priv || !data)
863 else if (!sdi->driver->config_set)
865 else if (sdi->status != SR_ST_ACTIVE) {
866 sr_err("%s: Device instance not active, can't set config.",
868 ret = SR_ERR_DEV_CLOSED;
869 } else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
871 else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
872 log_key(sdi, cg, key, SR_CONF_SET, data);
873 ret = sdi->driver->config_set(key, data, sdi, cg);
876 g_variant_unref(data);
878 if (ret == SR_ERR_CHANNEL_GROUP)
879 sr_err("%s: No channel group specified.",
880 (sdi) ? sdi->driver->name : "unknown");
886 * Apply configuration settings to the device hardware.
888 * @param sdi The device instance.
890 * @return SR_OK upon success or SR_ERR in case of error.
894 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
898 if (!sdi || !sdi->driver)
900 else if (!sdi->driver->config_commit)
902 else if (sdi->status != SR_ST_ACTIVE) {
903 sr_err("%s: Device instance not active, can't commit config.",
905 ret = SR_ERR_DEV_CLOSED;
907 ret = sdi->driver->config_commit(sdi);
913 * List all possible values for a configuration key.
915 * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
916 * @param[in] sdi (optional) If the key is specific to a device instance, this
917 * must contain a pointer to the struct sr_dev_inst to be checked.
918 * Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
920 * @param[in] cg The channel group on the device instance for which to list
921 * the values, or NULL. If this device instance doesn't
922 * have channel groups, this must not be != NULL.
923 * If cg is NULL, this function will return the "common" device
924 * instance options that are channel-group independent. Otherwise
925 * it will return the channel-group specific options.
926 * @param[in] key The configuration key (SR_CONF_*).
927 * @param[in,out] data A pointer to a GVariant where the list will be stored.
928 * The caller is given ownership of the GVariant and must thus
929 * unref the GVariant after use. However if this function
930 * returns an error code, the field should be considered
931 * unused, and should not be unreferenced.
933 * @retval SR_OK Success.
934 * @retval SR_ERR Error.
935 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
936 * interpreted as an error by the caller; merely as an indication
937 * that it's not applicable.
941 SR_API int sr_config_list(const struct sr_dev_driver *driver,
942 const struct sr_dev_inst *sdi,
943 const struct sr_channel_group *cg,
944 uint32_t key, GVariant **data)
948 if (!driver || !data)
951 if (!driver->config_list)
954 if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
955 if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
959 if (sdi && !sdi->priv) {
960 sr_err("Can't list config (sdi != NULL, sdi->priv == NULL).");
964 if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS && !sdi) {
965 sr_err("Config keys other than SR_CONF_SCAN_OPTIONS and "
966 "SR_CONF_DEVICE_OPTIONS always need an sdi.");
970 if (cg && sdi && !sdi->channel_groups) {
971 sr_err("Can't list config for channel group, there are none.");
975 if (cg && sdi && !g_slist_find(sdi->channel_groups, cg)) {
976 sr_err("If a channel group is specified, it must be a valid one.");
981 sr_err("Need sdi when a channel group is specified.");
985 if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
986 log_key(sdi, cg, key, SR_CONF_LIST, *data);
987 g_variant_ref_sink(*data);
990 if (ret == SR_ERR_CHANNEL_GROUP)
991 sr_err("%s: No channel group specified.",
992 (sdi) ? sdi->driver->name : "unknown");
997 static struct sr_key_info *get_keytable(int keytype)
999 struct sr_key_info *table;
1003 table = sr_key_info_config;
1006 table = sr_key_info_mq;
1008 case SR_KEY_MQFLAGS:
1009 table = sr_key_info_mqflag;
1012 sr_err("Invalid keytype %d", keytype);
1020 * Get information about a key, by key.
1022 * @param[in] keytype The namespace the key is in.
1023 * @param[in] key The key to find.
1025 * @return A pointer to a struct sr_key_info, or NULL if the key
1030 SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key)
1032 struct sr_key_info *table;
1035 if (!(table = get_keytable(keytype)))
1038 for (i = 0; table[i].key; i++) {
1039 if (table[i].key == key)
1047 * Get information about a key, by name.
1049 * @param[in] keytype The namespace the key is in.
1050 * @param[in] keyid The key id string.
1052 * @return A pointer to a struct sr_key_info, or NULL if the key
1057 SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid)
1059 struct sr_key_info *table;
1062 if (!(table = get_keytable(keytype)))
1065 for (i = 0; table[i].key; i++) {
1068 if (!strcmp(table[i].id, keyid))