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 static struct sr_config_info sr_config_info_data[] = {
52 {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic Analyzer", NULL},
53 {SR_CONF_OSCILLOSCOPE, SR_T_STRING, NULL, "Oscilloscope", NULL},
54 {SR_CONF_MULTIMETER, SR_T_STRING, NULL, "Multimeter", NULL},
55 {SR_CONF_DEMO_DEV, SR_T_STRING, NULL, "Demo device", NULL},
56 {SR_CONF_SOUNDLEVELMETER, SR_T_STRING, NULL, "Sound level meter", NULL},
57 {SR_CONF_THERMOMETER, SR_T_STRING, NULL, "Thermometer", NULL},
58 {SR_CONF_HYGROMETER, SR_T_STRING, NULL, "Hygrometer", NULL},
59 {SR_CONF_ENERGYMETER, SR_T_STRING, NULL, "Energy meter", NULL},
60 {SR_CONF_DEMODULATOR, SR_T_STRING, NULL, "Demodulator", NULL},
61 {SR_CONF_POWER_SUPPLY, SR_T_STRING, NULL, "Power supply", NULL},
62 {SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", NULL},
65 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
66 "Sample limit", NULL},
67 {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
69 {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
71 {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous",
72 "Continuous sampling", NULL},
75 {SR_CONF_CONN, SR_T_STRING, "conn",
77 {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
78 "Serial communication", NULL},
80 /* Device/channel group options */
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_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
88 "Trigger matches", NULL},
89 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
90 "External clock mode", NULL},
91 {SR_CONF_SWAP, SR_T_BOOL, "swap",
92 "Swap channel order", NULL},
93 {SR_CONF_RLE, SR_T_BOOL, "rle",
94 "Run Length Encoding", NULL},
95 {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
96 "Trigger slope", NULL},
97 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
98 "Trigger source", NULL},
99 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
100 "Horizontal trigger position", NULL},
101 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
102 "Buffer size", NULL},
103 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
105 {SR_CONF_FILTER, SR_T_BOOL, "filter",
107 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
109 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
111 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
113 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
114 "Sound pressure level frequency weighting", NULL},
115 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
116 "Sound pressure level time weighting", NULL},
117 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
119 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
121 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
122 "Sound pressure level measurement range", NULL},
123 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
124 "Voltage threshold", NULL },
125 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
127 {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
128 "Data source", NULL},
129 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
130 "Number of logic channels", NULL},
131 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
132 "Number of analog channels", NULL},
133 {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage",
134 "Current output voltage", NULL},
135 {SR_CONF_OUTPUT_VOLTAGE_TARGET, SR_T_FLOAT, "output_voltage_target",
136 "Output voltage target", NULL},
137 {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
138 "Current output current", NULL},
139 {SR_CONF_OUTPUT_CURRENT_LIMIT, SR_T_FLOAT, "output_current_limit",
140 "Output current limit", NULL},
141 {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
142 "Output enabled", NULL},
143 {SR_CONF_OUTPUT_CHANNEL_CONFIG, SR_T_STRING, "output_channel_config",
144 "Output channel modes", NULL},
145 {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
146 "Over-voltage protection enabled", NULL},
147 {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
148 "Over-voltage protection active", NULL},
149 {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
150 "Over-voltage protection threshold", NULL},
151 {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
152 "Over-current protection enabled", NULL},
153 {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
154 "Over-current protection active", NULL},
155 {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
156 "Over-current protection threshold", NULL},
157 {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
159 {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
161 {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
162 "Over-temperature protection", NULL},
163 {SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation",
164 "Output channel regulation", NULL},
165 {SR_CONF_OUTPUT_FREQUENCY, SR_T_UINT64, "output_frequency",
166 "Output frequency", NULL},
167 {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity",
168 "Measured quantity", NULL},
169 {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity",
170 "Measured secondary quantity", NULL},
171 {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
172 "Equivalent circuit model", NULL},
173 {0, 0, NULL, NULL, NULL},
176 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
180 return G_VARIANT_TYPE_INT32;
182 return G_VARIANT_TYPE_UINT64;
184 return G_VARIANT_TYPE_STRING;
186 return G_VARIANT_TYPE_BOOLEAN;
188 return G_VARIANT_TYPE_DOUBLE;
189 case SR_T_RATIONAL_PERIOD:
190 case SR_T_RATIONAL_VOLT:
191 case SR_T_UINT64_RANGE:
192 case SR_T_DOUBLE_RANGE:
193 return G_VARIANT_TYPE_TUPLE;
195 return G_VARIANT_TYPE_DICTIONARY;
201 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
203 const struct sr_config_info *info;
204 const GVariantType *type, *expected;
205 char *expected_string, *type_string;
207 info = sr_config_info_get(key);
211 expected = sr_variant_type_get(info->datatype);
212 type = g_variant_get_type(value);
213 if (!g_variant_type_equal(type, expected)
214 && !g_variant_type_is_subtype_of(type, expected)) {
215 expected_string = g_variant_type_dup_string(expected);
216 type_string = g_variant_type_dup_string(type);
217 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
218 info->name, expected_string, type_string);
219 g_free(expected_string);
228 * Return the list of supported hardware drivers.
230 * @return Pointer to the NULL-terminated list of hardware driver pointers.
234 SR_API struct sr_dev_driver **sr_driver_list(void)
241 * Initialize a hardware driver.
243 * This usually involves memory allocations and variable initializations
244 * within the driver, but _not_ scanning for attached devices.
245 * The API call sr_driver_scan() is used for that.
247 * @param ctx A libsigrok context object allocated by a previous call to
248 * sr_init(). Must not be NULL.
249 * @param driver The driver to initialize. This must be a pointer to one of
250 * the entries returned by sr_driver_list(). Must not be NULL.
252 * @retval SR_OK Success
253 * @retval SR_ERR_ARG Invalid parameter(s).
254 * @retval SR_ERR_BUG Internal errors.
255 * @retval other Another negative error code upon other errors.
259 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
264 sr_err("Invalid libsigrok context, can't initialize.");
269 sr_err("Invalid driver, can't initialize.");
273 sr_spew("Initializing driver '%s'.", driver->name);
274 if ((ret = driver->init(ctx)) < 0)
275 sr_err("Failed to initialize the driver: %d.", ret);
280 static int check_options(struct sr_dev_driver *driver, GSList *options,
281 uint32_t optlist_key, struct sr_dev_inst *sdi,
282 struct sr_channel_group *cg)
284 struct sr_config *src;
285 const struct sr_config_info *srci;
288 const uint32_t *opts;
292 if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
293 /* Driver publishes no options for this optlist. */
298 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
299 for (l = options; l; l = l->next) {
301 for (i = 0; i < num_opts; i++) {
302 if (opts[i] == src->key)
306 if (!(srci = sr_config_info_get(src->key)))
307 /* Shouldn't happen. */
308 sr_err("Invalid option %d.", src->key);
310 sr_err("Invalid option '%s'.", srci->id);
314 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
319 g_variant_unref(gvar_opts);
325 * Tell a hardware driver to scan for devices.
327 * In addition to the detection, the devices that are found are also
328 * initialized automatically. On some devices, this involves a firmware upload,
329 * or other such measures.
331 * The order in which the system is scanned for devices is not specified. The
332 * caller should not assume or rely on any specific order.
334 * Before calling sr_driver_scan(), the user must have previously initialized
335 * the driver by calling sr_driver_init().
337 * @param driver The driver that should scan. This must be a pointer to one of
338 * the entries returned by sr_driver_list(). Must not be NULL.
339 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
340 * scanner. Can be NULL/empty.
342 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
343 * found (or errors were encountered). This list must be freed by the
344 * caller using g_slist_free(), but without freeing the data pointed
349 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
354 sr_err("Invalid driver, can't scan for devices.");
359 sr_err("Driver not initialized, can't scan for devices.");
364 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
368 l = driver->scan(options);
370 sr_spew("Scan of '%s' found %d devices.", driver->name,
376 /** Call driver cleanup function for all drivers.
378 SR_PRIV void sr_hw_cleanup_all(void)
381 struct sr_dev_driver **drivers;
383 drivers = sr_driver_list();
384 for (i = 0; drivers[i]; i++) {
385 if (drivers[i]->cleanup)
386 drivers[i]->cleanup();
390 /** Allocate struct sr_config.
391 * A floating reference can be passed in for data.
394 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
396 struct sr_config *src;
398 if (!(src = g_try_malloc(sizeof(struct sr_config))))
401 src->data = g_variant_ref_sink(data);
406 /** Free struct sr_config.
409 SR_PRIV void sr_config_free(struct sr_config *src)
412 if (!src || !src->data) {
413 sr_err("%s: invalid data!", __func__);
417 g_variant_unref(src->data);
422 static int check_key(const struct sr_dev_driver *driver,
423 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
424 uint32_t key, int op)
426 const struct sr_config_info *srci;
429 const uint32_t *opts;
431 char *suffix, *opstr;
434 suffix = " for this device and channel group";
436 suffix = " for this device";
440 if (!(srci = sr_config_info_get(key))) {
441 sr_err("Invalid key %d.", key);
444 opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
445 sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s", opstr, key,
446 srci->id, sdi, cg ? cg->name : "NULL");
448 if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
449 /* Driver publishes no options. */
450 sr_err("No options available%s.", srci->id, suffix);
453 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
455 for (i = 0; i < num_opts; i++) {
456 if ((opts[i] & SR_CONF_MASK) == key) {
461 g_variant_unref(gvar_opts);
463 sr_err("Option '%s' not available%s.", srci->id, suffix);
467 if (!(pub_opt & op)) {
468 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
476 * Query value of a configuration key at the given driver or device instance.
478 * @param[in] driver The sr_dev_driver struct to query.
479 * @param[in] sdi (optional) If the key is specific to a device, this must
480 * contain a pointer to the struct sr_dev_inst to be checked.
481 * Otherwise it must be NULL.
482 * @param[in] cg The channel group on the device for which to list the
484 * @param[in] key The configuration key (SR_CONF_*).
485 * @param[in,out] data Pointer to a GVariant where the value will be stored.
486 * Must not be NULL. The caller is given ownership of the GVariant
487 * and must thus decrease the refcount after use. However if
488 * this function returns an error code, the field should be
489 * considered unused, and should not be unreferenced.
491 * @retval SR_OK Success.
492 * @retval SR_ERR Error.
493 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
494 * interpreted as an error by the caller; merely as an indication
495 * that it's not applicable.
499 SR_API int sr_config_get(const struct sr_dev_driver *driver,
500 const struct sr_dev_inst *sdi,
501 const struct sr_channel_group *cg,
502 uint32_t key, GVariant **data)
506 if (!driver || !data)
509 if (!driver->config_get)
512 if (check_key(driver, sdi, cg, key, SR_CONF_GET) != SR_OK)
515 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
516 /* Got a floating reference from the driver. Sink it here,
517 * caller will need to unref when done with it. */
518 g_variant_ref_sink(*data);
525 * Set value of a configuration key in a device instance.
527 * @param[in] sdi The device instance.
528 * @param[in] cg The channel group on the device for which to list the
530 * @param[in] key The configuration key (SR_CONF_*).
531 * @param data The new value for the key, as a GVariant with GVariantType
532 * appropriate to that key. A floating reference can be passed
533 * in; its refcount will be sunk and unreferenced after use.
535 * @retval SR_OK Success.
536 * @retval SR_ERR Error.
537 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
538 * interpreted as an error by the caller; merely as an indication
539 * that it's not applicable.
543 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
544 const struct sr_channel_group *cg,
545 uint32_t key, GVariant *data)
549 g_variant_ref_sink(data);
551 if (!sdi || !sdi->driver || !data)
553 else if (!sdi->driver->config_set)
555 else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET) != SR_OK)
557 else if ((ret = sr_variant_type_check(key, data)) == SR_OK)
558 ret = sdi->driver->config_set(key, data, sdi, cg);
560 g_variant_unref(data);
566 * Apply configuration settings to the device hardware.
568 * @param sdi The device instance.
570 * @return SR_OK upon success or SR_ERR in case of error.
574 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
578 if (!sdi || !sdi->driver)
580 else if (!sdi->driver->config_commit)
583 ret = sdi->driver->config_commit(sdi);
589 * List all possible values for a configuration key.
591 * @param[in] driver The sr_dev_driver struct to query.
592 * @param[in] sdi (optional) If the key is specific to a device, this must
593 * contain a pointer to the struct sr_dev_inst to be checked.
594 * @param[in] cg The channel group on the device for which to list the
596 * @param[in] key The configuration key (SR_CONF_*).
597 * @param[in,out] data A pointer to a GVariant where the list will be stored.
598 * The caller is given ownership of the GVariant and must thus
599 * unref the GVariant after use. However if this function
600 * returns an error code, the field should be considered
601 * unused, and should not be unreferenced.
603 * @retval SR_OK Success.
604 * @retval SR_ERR Error.
605 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
606 * interpreted as an error by the caller; merely as an indication
607 * that it's not applicable.
611 SR_API int sr_config_list(const struct sr_dev_driver *driver,
612 const struct sr_dev_inst *sdi,
613 const struct sr_channel_group *cg,
614 uint32_t key, GVariant **data)
618 if (!driver || !data)
620 else if (!driver->config_list)
622 else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
623 if (check_key(driver, sdi, cg, key, SR_CONF_LIST) != SR_OK)
626 if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
627 g_variant_ref_sink(*data);
633 * Get information about a configuration key, by key.
635 * @param[in] key The configuration key.
637 * @return A pointer to a struct sr_config_info, or NULL if the key
642 SR_API const struct sr_config_info *sr_config_info_get(uint32_t key)
646 for (i = 0; sr_config_info_data[i].key; i++) {
647 if (sr_config_info_data[i].key == key)
648 return &sr_config_info_data[i];
655 * Get information about a configuration key, by name.
657 * @param[in] optname The configuration key.
659 * @return A pointer to a struct sr_config_info, or NULL if the key
664 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
668 for (i = 0; sr_config_info_data[i].key; i++) {
669 if (!sr_config_info_data[i].id)
671 if (!strcmp(sr_config_info_data[i].id, optname))
672 return &sr_config_info_data[i];