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"
32 extern SR_PRIV struct sr_dev_driver testo_driver_info;
34 #define LOG_PREFIX "hwdriver"
40 * Hardware driver handling in libsigrok.
44 * @defgroup grp_driver Hardware drivers
46 * Hardware driver handling in libsigrok.
51 static struct sr_config_info sr_config_info_data[] = {
52 {SR_CONF_CONN, SR_T_STRING, "conn",
54 {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
55 "Serial communication", NULL},
56 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
58 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
59 "Pre-trigger capture ratio", NULL},
60 {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
62 {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
63 "Trigger matches", NULL},
64 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
65 "External clock mode", NULL},
66 {SR_CONF_SWAP, SR_T_BOOL, "swap",
67 "Swap channel order", NULL},
68 {SR_CONF_RLE, SR_T_BOOL, "rle",
69 "Run Length Encoding", NULL},
70 {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
71 "Trigger slope", NULL},
72 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
73 "Trigger source", NULL},
74 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
75 "Horizontal trigger position", NULL},
76 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
78 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
80 {SR_CONF_FILTER, SR_T_STRING, "filter",
81 "Filter targets", NULL},
82 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
84 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
86 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
88 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
89 "Sound pressure level frequency weighting", NULL},
90 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
91 "Sound pressure level time weighting", NULL},
92 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
94 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
96 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
97 "Sound pressure level measurement range", NULL},
98 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
99 "Voltage threshold", NULL },
100 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
102 {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
103 "Data source", NULL},
104 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
105 "Number of logic channels", NULL},
106 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
107 "Number of analog channels", NULL},
108 {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage",
109 "Current output voltage", NULL},
110 {SR_CONF_OUTPUT_VOLTAGE_MAX, SR_T_FLOAT, "output_voltage_max",
111 "Maximum output voltage", NULL},
112 {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
113 "Current output current", NULL},
114 {SR_CONF_OUTPUT_CURRENT_MAX, SR_T_FLOAT, "output_current_max",
115 "Maximum output current", NULL},
116 {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
117 "Output enabled", NULL},
118 {SR_CONF_OUTPUT_CHANNEL, SR_T_STRING, "output_channel",
119 "Output channel modes", NULL},
120 {SR_CONF_OVER_VOLTAGE_PROTECTION, SR_T_BOOL, "ovp",
121 "Over-voltage protection", NULL},
122 {SR_CONF_OVER_CURRENT_PROTECTION, SR_T_BOOL, "ocp",
123 "Over-current protection", NULL},
124 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
125 "Sample limit", NULL},
126 {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
128 {0, 0, NULL, NULL, NULL},
132 #ifdef HAVE_HW_APPA_55II
133 extern SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
135 #ifdef HAVE_HW_ATTEN_PPS3XXX
136 extern SR_PRIV struct sr_dev_driver atten_pps3203_driver_info;
138 #ifdef HAVE_HW_BRYMEN_BM86X
139 extern SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info;
141 #ifdef HAVE_HW_BRYMEN_DMM
142 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
144 #ifdef HAVE_HW_CEM_DT_885X
145 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
147 #ifdef HAVE_HW_CENTER_3XX
148 extern SR_PRIV struct sr_dev_driver center_309_driver_info;
149 extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
151 #ifdef HAVE_HW_COLEAD_SLM
152 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
154 #ifdef HAVE_HW_CONRAD_DIGI_35_CPU
155 extern SR_PRIV struct sr_dev_driver conrad_digi_35_cpu_driver_info;
158 extern SR_PRIV struct sr_dev_driver demo_driver_info;
160 #ifdef HAVE_HW_GMC_MH_1X_2X
161 extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
162 extern SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info;
164 #ifdef HAVE_HW_HAMEG_HMO
165 extern SR_PRIV struct sr_dev_driver hameg_hmo_driver_info;
167 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
168 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
170 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
171 extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
173 #ifdef HAVE_HW_KECHENG_KC_330B
174 extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
176 #ifdef HAVE_HW_LASCAR_EL_USB
177 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
179 #ifdef HAVE_HW_MANSON_HCS_3XXX
180 extern SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info;
182 #ifdef HAVE_HW_MIC_985XX
183 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
184 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
186 #ifdef HAVE_HW_MOTECH_LPS_30X
187 extern SR_PRIV struct sr_dev_driver motech_lps_301_driver_info;
189 #ifdef HAVE_HW_NORMA_DMM
190 extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
191 extern SR_PRIV struct sr_dev_driver siemens_b102x_driver_info;
194 extern SR_PRIV struct sr_dev_driver ols_driver_info;
196 #ifdef HAVE_HW_RIGOL_DS
197 extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
199 #ifdef HAVE_HW_SALEAE_LOGIC16
200 extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
202 #ifdef HAVE_HW_SYSCLK_LWLA
203 extern SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
205 #ifdef HAVE_HW_TELEINFO
206 extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
209 extern SR_PRIV struct sr_dev_driver testo_driver_info;
211 #ifdef HAVE_HW_TONDAJ_SL_814
212 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
214 #ifdef HAVE_HW_UNI_T_UT32X
215 extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
217 #ifdef HAVE_HW_VICTOR_DMM
218 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
220 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
221 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
223 #ifdef HAVE_HW_ASIX_SIGMA
224 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
226 #ifdef HAVE_HW_CHRONOVU_LA
227 extern SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
229 #ifdef HAVE_HW_LINK_MSO19
230 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
232 #ifdef HAVE_HW_FX2LAFW
233 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
235 #ifdef HAVE_HW_HANTEK_DSO
236 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
238 #ifdef HAVE_HW_AGILENT_DMM
239 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
241 #ifdef HAVE_HW_FLUKE_DMM
242 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
244 #ifdef HAVE_HW_SERIAL_DMM
245 extern SR_PRIV struct sr_dev_driver bbcgm_m2110_driver_info;
246 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
247 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
248 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
249 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
250 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
251 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
252 extern SR_PRIV struct sr_dev_driver va_va40b_driver_info;
253 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
254 extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
255 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
256 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
257 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
258 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
259 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
260 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
261 extern SR_PRIV struct sr_dev_driver voltcraft_m3650cr_driver_info;
262 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
263 extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
264 extern SR_PRIV struct sr_dev_driver voltcraft_me42_driver_info;
265 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
266 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
267 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
268 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
269 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
270 extern SR_PRIV struct sr_dev_driver uni_t_ut60g_ser_driver_info;
271 extern SR_PRIV struct sr_dev_driver uni_t_ut61b_ser_driver_info;
272 extern SR_PRIV struct sr_dev_driver uni_t_ut61c_ser_driver_info;
273 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
274 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
275 extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
276 extern SR_PRIV struct sr_dev_driver tenma_72_7745_ser_driver_info;
277 extern SR_PRIV struct sr_dev_driver tenma_72_7750_ser_driver_info;
279 #ifdef HAVE_HW_UNI_T_DMM
280 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
281 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
282 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
283 extern SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
284 extern SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
285 extern SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
286 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
287 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
288 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
289 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
290 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
291 extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
292 extern SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
296 static struct sr_dev_driver *drivers_list[] = {
297 #ifdef HAVE_HW_APPA_55II
298 &appa_55ii_driver_info,
300 #ifdef HAVE_HW_ATTEN_PPS3XXX
301 &atten_pps3203_driver_info,
303 #ifdef HAVE_HW_BRYMEN_BM86X
304 &brymen_bm86x_driver_info,
306 #ifdef HAVE_HW_BRYMEN_DMM
307 &brymen_bm857_driver_info,
309 #ifdef HAVE_HW_CEM_DT_885X
310 &cem_dt_885x_driver_info,
312 #ifdef HAVE_HW_CENTER_3XX
313 ¢er_309_driver_info,
314 &voltcraft_k204_driver_info,
316 #ifdef HAVE_HW_COLEAD_SLM
317 &colead_slm_driver_info,
319 #ifdef HAVE_HW_CONRAD_DIGI_35_CPU
320 &conrad_digi_35_cpu_driver_info,
325 #ifdef HAVE_HW_GMC_MH_1X_2X
326 &gmc_mh_1x_2x_rs232_driver_info,
327 &gmc_mh_2x_bd232_driver_info,
329 #ifdef HAVE_HW_HAMEG_HMO
330 &hameg_hmo_driver_info,
332 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
333 &ikalogic_scanalogic2_driver_info,
335 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
336 &ikalogic_scanaplus_driver_info,
338 #ifdef HAVE_HW_KECHENG_KC_330B
339 &kecheng_kc_330b_driver_info,
341 #ifdef HAVE_HW_LASCAR_EL_USB
342 &lascar_el_usb_driver_info,
344 #ifdef HAVE_HW_MANSON_HCS_3XXX
345 &manson_hcs_3xxx_driver_info,
347 #ifdef HAVE_HW_MIC_985XX
348 &mic_98581_driver_info,
349 &mic_98583_driver_info,
351 #ifdef HAVE_HW_MOTECH_LPS_30X
352 &motech_lps_301_driver_info,
354 #ifdef HAVE_HW_NORMA_DMM
355 &norma_dmm_driver_info,
356 &siemens_b102x_driver_info,
361 #ifdef HAVE_HW_RIGOL_DS
362 &rigol_ds_driver_info,
364 #ifdef HAVE_HW_SALEAE_LOGIC16
365 &saleae_logic16_driver_info,
367 #ifdef HAVE_HW_SYSCLK_LWLA
368 &sysclk_lwla_driver_info,
370 #ifdef HAVE_HW_TELEINFO
371 &teleinfo_driver_info,
376 #ifdef HAVE_HW_TONDAJ_SL_814
377 &tondaj_sl_814_driver_info,
379 #ifdef HAVE_HW_UNI_T_UT32X
380 &uni_t_ut32x_driver_info,
382 #ifdef HAVE_HW_VICTOR_DMM
383 &victor_dmm_driver_info,
385 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
386 &zeroplus_logic_cube_driver_info,
388 #ifdef HAVE_HW_ASIX_SIGMA
389 &asix_sigma_driver_info,
391 #ifdef HAVE_HW_CHRONOVU_LA
392 &chronovu_la_driver_info,
394 #ifdef HAVE_HW_LINK_MSO19
395 &link_mso19_driver_info,
397 #ifdef HAVE_HW_FX2LAFW
398 &fx2lafw_driver_info,
400 #ifdef HAVE_HW_HANTEK_DSO
401 &hantek_dso_driver_info,
403 #ifdef HAVE_HW_AGILENT_DMM
406 #ifdef HAVE_HW_FLUKE_DMM
407 &flukedmm_driver_info,
409 #ifdef HAVE_HW_SERIAL_DMM
410 &bbcgm_m2110_driver_info,
411 &digitek_dt4000zc_driver_info,
412 &tekpower_tp4000zc_driver_info,
413 &metex_me31_driver_info,
414 &peaktech_3410_driver_info,
415 &mastech_mas345_driver_info,
416 &va_va18b_driver_info,
417 &va_va40b_driver_info,
418 &metex_m3640d_driver_info,
419 &metex_m4650cr_driver_info,
420 &peaktech_4370_driver_info,
421 &pce_pce_dm32_driver_info,
422 &radioshack_22_168_driver_info,
423 &radioshack_22_805_driver_info,
424 &radioshack_22_812_driver_info,
425 &tecpel_dmm_8061_ser_driver_info,
426 &voltcraft_m3650cr_driver_info,
427 &voltcraft_m3650d_driver_info,
428 &voltcraft_m4650cr_driver_info,
429 &voltcraft_me42_driver_info,
430 &voltcraft_vc820_ser_driver_info,
431 &voltcraft_vc830_ser_driver_info,
432 &voltcraft_vc840_ser_driver_info,
433 &uni_t_ut60a_ser_driver_info,
434 &uni_t_ut60e_ser_driver_info,
435 &uni_t_ut60g_ser_driver_info,
436 &uni_t_ut61b_ser_driver_info,
437 &uni_t_ut61c_ser_driver_info,
438 &uni_t_ut61d_ser_driver_info,
439 &uni_t_ut61e_ser_driver_info,
440 &iso_tech_idm103n_driver_info,
441 &tenma_72_7745_ser_driver_info,
442 &tenma_72_7750_ser_driver_info,
444 #ifdef HAVE_HW_UNI_T_DMM
445 &tecpel_dmm_8061_driver_info,
446 &uni_t_ut60a_driver_info,
447 &uni_t_ut60e_driver_info,
448 &uni_t_ut60g_driver_info,
449 &uni_t_ut61b_driver_info,
450 &uni_t_ut61c_driver_info,
451 &uni_t_ut61d_driver_info,
452 &uni_t_ut61e_driver_info,
453 &voltcraft_vc820_driver_info,
454 &voltcraft_vc830_driver_info,
455 &voltcraft_vc840_driver_info,
456 &tenma_72_7745_driver_info,
457 &tenma_72_7750_driver_info,
463 * Return the list of supported hardware drivers.
465 * @return Pointer to the NULL-terminated list of hardware driver pointers.
469 SR_API struct sr_dev_driver **sr_driver_list(void)
476 * Initialize a hardware driver.
478 * This usually involves memory allocations and variable initializations
479 * within the driver, but _not_ scanning for attached devices.
480 * The API call sr_driver_scan() is used for that.
482 * @param ctx A libsigrok context object allocated by a previous call to
483 * sr_init(). Must not be NULL.
484 * @param driver The driver to initialize. This must be a pointer to one of
485 * the entries returned by sr_driver_list(). Must not be NULL.
487 * @retval SR_OK Success
488 * @retval SR_ERR_ARG Invalid parameter(s).
489 * @retval SR_ERR_BUG Internal errors.
490 * @retval other Another negative error code upon other errors.
494 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
499 sr_err("Invalid libsigrok context, can't initialize.");
504 sr_err("Invalid driver, can't initialize.");
508 sr_spew("Initializing driver '%s'.", driver->name);
509 if ((ret = driver->init(ctx)) < 0)
510 sr_err("Failed to initialize the driver: %d.", ret);
516 * Tell a hardware driver to scan for devices.
518 * In addition to the detection, the devices that are found are also
519 * initialized automatically. On some devices, this involves a firmware upload,
520 * or other such measures.
522 * The order in which the system is scanned for devices is not specified. The
523 * caller should not assume or rely on any specific order.
525 * Before calling sr_driver_scan(), the user must have previously initialized
526 * the driver by calling sr_driver_init().
528 * @param driver The driver that should scan. This must be a pointer to one of
529 * the entries returned by sr_driver_list(). Must not be NULL.
530 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
531 * scanner. Can be NULL/empty.
533 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
534 * found (or errors were encountered). This list must be freed by the
535 * caller using g_slist_free(), but without freeing the data pointed
540 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
545 sr_err("Invalid driver, can't scan for devices.");
550 sr_err("Driver not initialized, can't scan for devices.");
554 l = driver->scan(options);
556 sr_spew("Scan of '%s' found %d devices.", driver->name,
562 /** Call driver cleanup function for all drivers.
564 SR_PRIV void sr_hw_cleanup_all(void)
567 struct sr_dev_driver **drivers;
569 drivers = sr_driver_list();
570 for (i = 0; drivers[i]; i++) {
571 if (drivers[i]->cleanup)
572 drivers[i]->cleanup();
576 /** Allocate struct sr_config.
577 * A floating reference can be passed in for data.
580 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
582 struct sr_config *src;
584 if (!(src = g_try_malloc(sizeof(struct sr_config))))
587 src->data = g_variant_ref_sink(data);
592 /** Free struct sr_config.
595 SR_PRIV void sr_config_free(struct sr_config *src)
598 if (!src || !src->data) {
599 sr_err("%s: invalid data!", __func__);
603 g_variant_unref(src->data);
609 * Query value of a configuration key at the given driver or device instance.
611 * @param[in] driver The sr_dev_driver struct to query.
612 * @param[in] sdi (optional) If the key is specific to a device, this must
613 * contain a pointer to the struct sr_dev_inst to be checked.
614 * Otherwise it must be NULL.
615 * @param[in] cg The channel group on the device for which to list the
617 * @param[in] key The configuration key (SR_CONF_*).
618 * @param[in,out] data Pointer to a GVariant where the value will be stored.
619 * Must not be NULL. The caller is given ownership of the GVariant
620 * and must thus decrease the refcount after use. However if
621 * this function returns an error code, the field should be
622 * considered unused, and should not be unreferenced.
624 * @retval SR_OK Success.
625 * @retval SR_ERR Error.
626 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
627 * interpreted as an error by the caller; merely as an indication
628 * that it's not applicable.
632 SR_API int sr_config_get(const struct sr_dev_driver *driver,
633 const struct sr_dev_inst *sdi,
634 const struct sr_channel_group *cg,
635 int key, GVariant **data)
639 if (!driver || !data)
642 if (!driver->config_get)
645 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
646 /* Got a floating reference from the driver. Sink it here,
647 * caller will need to unref when done with it. */
648 g_variant_ref_sink(*data);
655 * Set value of a configuration key in a device instance.
657 * @param[in] sdi The device instance.
658 * @param[in] cg The channel group on the device for which to list the
660 * @param[in] key The configuration key (SR_CONF_*).
661 * @param data The new value for the key, as a GVariant with GVariantType
662 * appropriate to that key. A floating reference can be passed
663 * in; its refcount will be sunk and unreferenced after use.
665 * @retval SR_OK Success.
666 * @retval SR_ERR Error.
667 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
668 * interpreted as an error by the caller; merely as an indication
669 * that it's not applicable.
673 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
674 const struct sr_channel_group *cg,
675 int key, GVariant *data)
679 g_variant_ref_sink(data);
681 if (!sdi || !sdi->driver || !data)
683 else if (!sdi->driver->config_set)
686 ret = sdi->driver->config_set(key, data, sdi, cg);
688 g_variant_unref(data);
694 * Apply configuration settings to the device hardware.
696 * @param sdi The device instance.
698 * @return SR_OK upon success or SR_ERR in case of error.
702 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
706 if (!sdi || !sdi->driver)
708 else if (!sdi->driver->config_commit)
711 ret = sdi->driver->config_commit(sdi);
717 * List all possible values for a configuration key.
719 * @param[in] driver The sr_dev_driver struct to query.
720 * @param[in] sdi (optional) If the key is specific to a device, this must
721 * contain a pointer to the struct sr_dev_inst to be checked.
722 * @param[in] cg The channel group on the device for which to list the
724 * @param[in] key The configuration key (SR_CONF_*).
725 * @param[in,out] data A pointer to a GVariant where the list will be stored.
726 * The caller is given ownership of the GVariant and must thus
727 * unref the GVariant after use. However if this function
728 * returns an error code, the field should be considered
729 * unused, and should not be unreferenced.
731 * @retval SR_OK Success.
732 * @retval SR_ERR Error.
733 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
734 * interpreted as an error by the caller; merely as an indication
735 * that it's not applicable.
739 SR_API int sr_config_list(const struct sr_dev_driver *driver,
740 const struct sr_dev_inst *sdi,
741 const struct sr_channel_group *cg,
742 int key, GVariant **data)
746 if (!driver || !data)
748 else if (!driver->config_list)
750 else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
751 g_variant_ref_sink(*data);
757 * Get information about a configuration key, by key.
759 * @param[in] key The configuration key.
761 * @return A pointer to a struct sr_config_info, or NULL if the key
766 SR_API const struct sr_config_info *sr_config_info_get(int key)
770 for (i = 0; sr_config_info_data[i].key; i++) {
771 if (sr_config_info_data[i].key == key)
772 return &sr_config_info_data[i];
779 * Get information about a configuration key, by name.
781 * @param[in] optname The configuration key.
783 * @return A pointer to a struct sr_config_info, or NULL if the key
788 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
792 for (i = 0; sr_config_info_data[i].key; i++) {
793 if (!strcmp(sr_config_info_data[i].id, optname))
794 return &sr_config_info_data[i];
800 /* Unnecessary level of indirection follows. */
803 * @see sr_session_source_remove()
805 SR_PRIV int sr_source_remove(int fd)
807 return sr_session_source_remove(fd);
811 * @see sr_session_source_add()
813 SR_PRIV int sr_source_add(int fd, int events, int timeout,
814 sr_receive_data_callback cb, void *cb_data)
816 return sr_session_source_add(fd, events, timeout, cb, cb_data);