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/>.
22 #include <sys/types.h>
26 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
31 #define LOG_PREFIX "hwdriver"
34 extern SR_PRIV struct sr_dev_driver *drivers_list[];
39 * Hardware driver handling in libsigrok.
43 * @defgroup grp_driver Hardware drivers
45 * Hardware driver handling in libsigrok.
50 /* Same key order/grouping as in enum sr_configkey (libsigrok.h). */
51 static struct sr_config_info sr_config_info_data[] = {
53 {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic analyzer", NULL},
54 {SR_CONF_OSCILLOSCOPE, SR_T_STRING, NULL, "Oscilloscope", NULL},
55 {SR_CONF_MULTIMETER, SR_T_STRING, NULL, "Multimeter", NULL},
56 {SR_CONF_DEMO_DEV, SR_T_STRING, NULL, "Demo device", NULL},
57 {SR_CONF_SOUNDLEVELMETER, SR_T_STRING, NULL, "Sound level meter", NULL},
58 {SR_CONF_THERMOMETER, SR_T_STRING, NULL, "Thermometer", NULL},
59 {SR_CONF_HYGROMETER, SR_T_STRING, NULL, "Hygrometer", NULL},
60 {SR_CONF_ENERGYMETER, SR_T_STRING, NULL, "Energy meter", NULL},
61 {SR_CONF_DEMODULATOR, SR_T_STRING, NULL, "Demodulator", NULL},
62 {SR_CONF_POWER_SUPPLY, SR_T_STRING, NULL, "Power supply", NULL},
63 {SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", 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},
71 /* Device (or channel group) configuration */
72 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
74 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
75 "Pre-trigger capture ratio", NULL},
76 {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
78 {SR_CONF_RLE, SR_T_BOOL, "rle",
79 "Run length encoding", NULL},
80 {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
81 "Trigger slope", NULL},
82 {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
84 {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
85 "Number of samples to average over", NULL},
86 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
87 "Trigger source", NULL},
88 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
89 "Horizontal trigger position", NULL},
90 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
92 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
94 {SR_CONF_FILTER, SR_T_BOOL, "filter",
96 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
98 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
100 {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
101 "Trigger matches", NULL},
102 {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
103 "Sample interval", NULL},
104 {SR_CONF_NUM_TIMEBASE, SR_T_INT32, "num_timebase",
105 "Number of time bases", NULL},
106 {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
107 "Number of vertical divisions", NULL},
108 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
109 "Sound pressure level frequency weighting", NULL},
110 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
111 "Sound pressure level time weighting", NULL},
112 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
113 "Sound pressure level measurement range", NULL},
114 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
116 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
118 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
119 "Voltage threshold", NULL },
120 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
121 "External clock mode", NULL},
122 {SR_CONF_SWAP, SR_T_BOOL, "swap",
123 "Swap channel order", NULL},
124 {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
125 "Center frequency", NULL},
126 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
127 "Number of logic channels", NULL},
128 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
129 "Number of analog channels", NULL},
130 {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage",
131 "Current output voltage", NULL},
132 {SR_CONF_OUTPUT_VOLTAGE_TARGET, SR_T_FLOAT, "output_voltage_target",
133 "Output voltage target", NULL},
134 {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
135 "Current output current", NULL},
136 {SR_CONF_OUTPUT_CURRENT_LIMIT, SR_T_FLOAT, "output_current_limit",
137 "Output current limit", NULL},
138 {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
139 "Output enabled", NULL},
140 {SR_CONF_OUTPUT_CHANNEL_CONFIG, SR_T_STRING, "output_channel_config",
141 "Output channel modes", NULL},
142 {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
143 "Over-voltage protection enabled", NULL},
144 {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
145 "Over-voltage protection active", NULL},
146 {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
147 "Over-voltage protection threshold", NULL},
148 {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
149 "Over-current protection enabled", NULL},
150 {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
151 "Over-current protection active", NULL},
152 {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
153 "Over-current protection threshold", NULL},
154 {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
156 {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
158 {SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation",
159 "Output channel regulation", NULL},
160 {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
161 "Over-temperature protection", NULL},
162 {SR_CONF_OUTPUT_FREQUENCY, SR_T_UINT64, "output_frequency",
163 "Output frequency", NULL},
164 {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity",
165 "Measured quantity", NULL},
166 {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity",
167 "Measured secondary quantity", NULL},
168 {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
169 "Equivalent circuit model", NULL},
172 {SR_CONF_SCAN_OPTIONS, SR_T_STRING, "scan_options",
173 "Scan options", NULL},
174 {SR_CONF_DEVICE_OPTIONS, SR_T_STRING, "device_options",
175 "Device options", NULL},
176 {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
177 "Session file", NULL},
178 {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile",
179 "Capture file", NULL},
180 {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize",
181 "Capture unitsize", NULL},
182 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
184 {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
185 "Data source", NULL},
187 /* Acquisition modes, sample limiting */
188 {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
190 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
191 "Sample limit", NULL},
192 {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
193 "Frame limit", NULL},
194 {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous",
195 "Continuous sampling", NULL},
196 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
198 {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
199 "Device mode", NULL},
200 {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
203 {0, 0, NULL, NULL, NULL},
206 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
210 return G_VARIANT_TYPE_INT32;
212 return G_VARIANT_TYPE_UINT64;
214 return G_VARIANT_TYPE_STRING;
216 return G_VARIANT_TYPE_BOOLEAN;
218 return G_VARIANT_TYPE_DOUBLE;
219 case SR_T_RATIONAL_PERIOD:
220 case SR_T_RATIONAL_VOLT:
221 case SR_T_UINT64_RANGE:
222 case SR_T_DOUBLE_RANGE:
223 return G_VARIANT_TYPE_TUPLE;
225 return G_VARIANT_TYPE_DICTIONARY;
231 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
233 const struct sr_config_info *info;
234 const GVariantType *type, *expected;
235 char *expected_string, *type_string;
237 info = sr_config_info_get(key);
241 expected = sr_variant_type_get(info->datatype);
242 type = g_variant_get_type(value);
243 if (!g_variant_type_equal(type, expected)
244 && !g_variant_type_is_subtype_of(type, expected)) {
245 expected_string = g_variant_type_dup_string(expected);
246 type_string = g_variant_type_dup_string(type);
247 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
248 info->name, expected_string, type_string);
249 g_free(expected_string);
258 * Return the list of supported hardware drivers.
260 * @return Pointer to the NULL-terminated list of hardware driver pointers.
264 SR_API struct sr_dev_driver **sr_driver_list(void)
271 * Initialize a hardware driver.
273 * This usually involves memory allocations and variable initializations
274 * within the driver, but _not_ scanning for attached devices.
275 * The API call sr_driver_scan() is used for that.
277 * @param ctx A libsigrok context object allocated by a previous call to
278 * sr_init(). Must not be NULL.
279 * @param driver The driver to initialize. This must be a pointer to one of
280 * the entries returned by sr_driver_list(). Must not be NULL.
282 * @retval SR_OK Success
283 * @retval SR_ERR_ARG Invalid parameter(s).
284 * @retval SR_ERR_BUG Internal errors.
285 * @retval other Another negative error code upon other errors.
289 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
294 sr_err("Invalid libsigrok context, can't initialize.");
299 sr_err("Invalid driver, can't initialize.");
303 sr_spew("Initializing driver '%s'.", driver->name);
304 if ((ret = driver->init(ctx)) < 0)
305 sr_err("Failed to initialize the driver: %d.", ret);
310 static int check_options(struct sr_dev_driver *driver, GSList *options,
311 uint32_t optlist_key, struct sr_dev_inst *sdi,
312 struct sr_channel_group *cg)
314 struct sr_config *src;
315 const struct sr_config_info *srci;
318 const uint32_t *opts;
322 if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
323 /* Driver publishes no options for this optlist. */
328 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
329 for (l = options; l; l = l->next) {
331 for (i = 0; i < num_opts; i++) {
332 if (opts[i] == src->key)
336 if (!(srci = sr_config_info_get(src->key)))
337 /* Shouldn't happen. */
338 sr_err("Invalid option %d.", src->key);
340 sr_err("Invalid option '%s'.", srci->id);
344 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
349 g_variant_unref(gvar_opts);
355 * Tell a hardware driver to scan for devices.
357 * In addition to the detection, the devices that are found are also
358 * initialized automatically. On some devices, this involves a firmware upload,
359 * or other such measures.
361 * The order in which the system is scanned for devices is not specified. The
362 * caller should not assume or rely on any specific order.
364 * Before calling sr_driver_scan(), the user must have previously initialized
365 * the driver by calling sr_driver_init().
367 * @param driver The driver that should scan. This must be a pointer to one of
368 * the entries returned by sr_driver_list(). Must not be NULL.
369 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
370 * scanner. Can be NULL/empty.
372 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
373 * found (or errors were encountered). This list must be freed by the
374 * caller using g_slist_free(), but without freeing the data pointed
379 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
384 sr_err("Invalid driver, can't scan for devices.");
389 sr_err("Driver not initialized, can't scan for devices.");
394 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
398 l = driver->scan(options);
400 sr_spew("Scan of '%s' found %d devices.", driver->name,
406 /** Call driver cleanup function for all drivers.
408 SR_PRIV void sr_hw_cleanup_all(void)
411 struct sr_dev_driver **drivers;
413 drivers = sr_driver_list();
414 for (i = 0; drivers[i]; i++) {
415 if (drivers[i]->cleanup)
416 drivers[i]->cleanup();
420 /** Allocate struct sr_config.
421 * A floating reference can be passed in for data.
424 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
426 struct sr_config *src;
428 src = g_malloc0(sizeof(struct sr_config));
430 src->data = g_variant_ref_sink(data);
435 /** Free struct sr_config.
438 SR_PRIV void sr_config_free(struct sr_config *src)
441 if (!src || !src->data) {
442 sr_err("%s: invalid data!", __func__);
446 g_variant_unref(src->data);
451 static int check_key(const struct sr_dev_driver *driver,
452 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
453 uint32_t key, int op)
455 const struct sr_config_info *srci;
458 const uint32_t *opts;
460 char *suffix, *opstr;
463 suffix = " for this device and channel group";
465 suffix = " for this device";
469 if (!(srci = sr_config_info_get(key))) {
470 sr_err("Invalid key %d.", key);
473 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
474 sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s", opstr, key,
475 srci->id, sdi, cg ? cg->name : "NULL");
477 if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
478 /* Driver publishes no options. */
479 sr_err("No options available%s.", srci->id, suffix);
482 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
484 for (i = 0; i < num_opts; i++) {
485 if ((opts[i] & SR_CONF_MASK) == key) {
490 g_variant_unref(gvar_opts);
492 sr_err("Option '%s' not available%s.", srci->id, suffix);
496 if (!(pub_opt & op)) {
497 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
505 * Query value of a configuration key at the given driver or device instance.
507 * @param[in] driver The sr_dev_driver struct to query.
508 * @param[in] sdi (optional) If the key is specific to a device, this must
509 * contain a pointer to the struct sr_dev_inst to be checked.
510 * Otherwise it must be NULL.
511 * @param[in] cg The channel group on the device for which to list the
513 * @param[in] key The configuration key (SR_CONF_*).
514 * @param[in,out] data Pointer to a GVariant where the value will be stored.
515 * Must not be NULL. The caller is given ownership of the GVariant
516 * and must thus decrease the refcount after use. However if
517 * this function returns an error code, the field should be
518 * considered unused, and should not be unreferenced.
520 * @retval SR_OK Success.
521 * @retval SR_ERR Error.
522 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
523 * interpreted as an error by the caller; merely as an indication
524 * that it's not applicable.
528 SR_API int sr_config_get(const struct sr_dev_driver *driver,
529 const struct sr_dev_inst *sdi,
530 const struct sr_channel_group *cg,
531 uint32_t key, GVariant **data)
535 if (!driver || !data)
538 if (!driver->config_get)
541 if (check_key(driver, sdi, cg, key, SR_CONF_GET) != SR_OK)
544 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
545 /* Got a floating reference from the driver. Sink it here,
546 * caller will need to unref when done with it. */
547 g_variant_ref_sink(*data);
554 * Set value of a configuration key in a device instance.
556 * @param[in] sdi The device instance.
557 * @param[in] cg The channel group on the device for which to list the
559 * @param[in] key The configuration key (SR_CONF_*).
560 * @param data The new value for the key, as a GVariant with GVariantType
561 * appropriate to that key. A floating reference can be passed
562 * in; its refcount will be sunk and unreferenced after use.
564 * @retval SR_OK Success.
565 * @retval SR_ERR Error.
566 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
567 * interpreted as an error by the caller; merely as an indication
568 * that it's not applicable.
572 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
573 const struct sr_channel_group *cg,
574 uint32_t key, GVariant *data)
578 g_variant_ref_sink(data);
580 if (!sdi || !sdi->driver || !data)
582 else if (!sdi->driver->config_set)
584 else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET) != SR_OK)
586 else if ((ret = sr_variant_type_check(key, data)) == SR_OK)
587 ret = sdi->driver->config_set(key, data, sdi, cg);
589 g_variant_unref(data);
595 * Apply configuration settings to the device hardware.
597 * @param sdi The device instance.
599 * @return SR_OK upon success or SR_ERR in case of error.
603 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
607 if (!sdi || !sdi->driver)
609 else if (!sdi->driver->config_commit)
612 ret = sdi->driver->config_commit(sdi);
618 * List all possible values for a configuration key.
620 * @param[in] driver The sr_dev_driver struct to query.
621 * @param[in] sdi (optional) If the key is specific to a device, this must
622 * contain a pointer to the struct sr_dev_inst to be checked.
623 * @param[in] cg The channel group on the device for which to list the
625 * @param[in] key The configuration key (SR_CONF_*).
626 * @param[in,out] data A pointer to a GVariant where the list will be stored.
627 * The caller is given ownership of the GVariant and must thus
628 * unref the GVariant after use. However if this function
629 * returns an error code, the field should be considered
630 * unused, and should not be unreferenced.
632 * @retval SR_OK Success.
633 * @retval SR_ERR Error.
634 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
635 * interpreted as an error by the caller; merely as an indication
636 * that it's not applicable.
640 SR_API int sr_config_list(const struct sr_dev_driver *driver,
641 const struct sr_dev_inst *sdi,
642 const struct sr_channel_group *cg,
643 uint32_t key, GVariant **data)
647 if (!driver || !data)
649 else if (!driver->config_list)
651 else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
652 if (check_key(driver, sdi, cg, key, SR_CONF_LIST) != SR_OK)
655 if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
656 g_variant_ref_sink(*data);
662 * Get information about a configuration key, by key.
664 * @param[in] key The configuration key.
666 * @return A pointer to a struct sr_config_info, or NULL if the key
671 SR_API const struct sr_config_info *sr_config_info_get(uint32_t key)
675 for (i = 0; sr_config_info_data[i].key; i++) {
676 if (sr_config_info_data[i].key == key)
677 return &sr_config_info_data[i];
684 * Get information about a configuration key, by name.
686 * @param[in] optname The configuration key.
688 * @return A pointer to a struct sr_config_info, or NULL if the key
693 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
697 for (i = 0; sr_config_info_data[i].key; i++) {
698 if (!sr_config_info_data[i].id)
700 if (!strcmp(sr_config_info_data[i].id, optname))
701 return &sr_config_info_data[i];