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"
37 * Hardware driver handling in libsigrok.
41 * @defgroup grp_driver Hardware drivers
43 * Hardware driver handling in libsigrok.
48 static struct sr_config_info sr_config_info_data[] = {
49 {SR_CONF_CONN, SR_T_CHAR, "conn",
51 {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
52 "Serial communication", NULL},
53 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
55 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
56 "Pre-trigger capture ratio", NULL},
57 {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
59 {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
60 "Trigger types", NULL},
61 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
62 "External clock mode", NULL},
63 {SR_CONF_SWAP, SR_T_BOOL, "swap",
64 "Swap channel order", NULL},
65 {SR_CONF_RLE, SR_T_BOOL, "rle",
66 "Run Length Encoding", NULL},
67 {SR_CONF_TRIGGER_SLOPE, SR_T_CHAR, "triggerslope",
68 "Trigger slope", NULL},
69 {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
70 "Trigger source", NULL},
71 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
72 "Horizontal trigger position", NULL},
73 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
75 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
77 {SR_CONF_FILTER, SR_T_CHAR, "filter",
78 "Filter targets", NULL},
79 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
81 {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
83 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
85 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq",
86 "Sound pressure level frequency weighting", NULL},
87 {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time",
88 "Sound pressure level time weighting", NULL},
89 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
91 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
93 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
94 "Sound pressure level measurement range", NULL},
95 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
96 "Voltage threshold", NULL },
97 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
99 {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
100 "Data source", NULL},
101 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
102 "Number of logic channels", NULL},
103 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
104 "Number of analog channels", NULL},
105 {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage",
106 "Current output voltage", NULL},
107 {SR_CONF_OUTPUT_VOLTAGE_MAX, SR_T_FLOAT, "output_voltage_max",
108 "Maximum output voltage", NULL},
109 {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
110 "Current output current", NULL},
111 {SR_CONF_OUTPUT_CURRENT_MAX, SR_T_FLOAT, "output_current_max",
112 "Maximum output current", NULL},
113 {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
114 "Output enabled", NULL},
115 {SR_CONF_OUTPUT_CHANNEL, SR_T_CHAR, "output_channel",
116 "Output channel modes", NULL},
117 {SR_CONF_OVER_VOLTAGE_PROTECTION, SR_T_BOOL, "ovp",
118 "Over-voltage protection", NULL},
119 {SR_CONF_OVER_CURRENT_PROTECTION, SR_T_BOOL, "ocp",
120 "Over-current protection", NULL},
121 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
122 "Sample limit", NULL},
123 {SR_CONF_CLOCK_EDGE, SR_T_CHAR, "clock_edge",
125 {0, 0, NULL, NULL, NULL},
129 #ifdef HAVE_HW_APPA_55II
130 extern SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
132 #ifdef HAVE_HW_ATTEN_PPS3XXX
133 extern SR_PRIV struct sr_dev_driver atten_pps3203_driver_info;
135 #ifdef HAVE_HW_BRYMEN_BM86X
136 extern SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info;
138 #ifdef HAVE_HW_BRYMEN_DMM
139 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
141 #ifdef HAVE_HW_CEM_DT_885X
142 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
144 #ifdef HAVE_HW_CENTER_3XX
145 extern SR_PRIV struct sr_dev_driver center_309_driver_info;
146 extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
148 #ifdef HAVE_HW_COLEAD_SLM
149 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
151 #ifdef HAVE_HW_CONRAD_DIGI_35_CPU
152 extern SR_PRIV struct sr_dev_driver conrad_digi_35_cpu_driver_info;
155 extern SR_PRIV struct sr_dev_driver demo_driver_info;
157 #ifdef HAVE_HW_GMC_MH_1X_2X
158 extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
159 extern SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info;
161 #ifdef HAVE_HW_HAMEG_HMO
162 extern SR_PRIV struct sr_dev_driver hameg_hmo_driver_info;
164 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
165 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
167 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
168 extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
170 #ifdef HAVE_HW_KECHENG_KC_330B
171 extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
173 #ifdef HAVE_HW_LASCAR_EL_USB
174 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
176 #ifdef HAVE_HW_MIC_985XX
177 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
178 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
180 #ifdef HAVE_HW_NORMA_DMM
181 extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
184 extern SR_PRIV struct sr_dev_driver ols_driver_info;
186 #ifdef HAVE_HW_RIGOL_DS
187 extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
189 #ifdef HAVE_HW_SALEAE_LOGIC16
190 extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
192 #ifdef HAVE_HW_SYSCLK_LWLA
193 extern SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
195 #ifdef HAVE_HW_TELEINFO
196 extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
198 #ifdef HAVE_HW_TONDAJ_SL_814
199 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
201 #ifdef HAVE_HW_UNI_T_UT32X
202 extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
204 #ifdef HAVE_HW_VICTOR_DMM
205 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
207 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
208 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
210 #ifdef HAVE_HW_ASIX_SIGMA
211 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
213 #ifdef HAVE_HW_CHRONOVU_LA
214 extern SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
216 #ifdef HAVE_HW_LINK_MSO19
217 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
220 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
222 #ifdef HAVE_HW_FX2LAFW
223 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
225 #ifdef HAVE_HW_HANTEK_DSO
226 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
228 #ifdef HAVE_HW_AGILENT_DMM
229 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
231 #ifdef HAVE_HW_FLUKE_DMM
232 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
234 #ifdef HAVE_HW_SERIAL_DMM
235 extern SR_PRIV struct sr_dev_driver bbcgm_m2110_driver_info;
236 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
237 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
238 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
239 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
240 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
241 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
242 extern SR_PRIV struct sr_dev_driver va_va40b_driver_info;
243 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
244 extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
245 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
246 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
247 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
248 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
249 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
250 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
251 extern SR_PRIV struct sr_dev_driver voltcraft_m3650cr_driver_info;
252 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
253 extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
254 extern SR_PRIV struct sr_dev_driver voltcraft_me42_driver_info;
255 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
256 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
257 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
258 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
259 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
260 extern SR_PRIV struct sr_dev_driver uni_t_ut60g_ser_driver_info;
261 extern SR_PRIV struct sr_dev_driver uni_t_ut61b_ser_driver_info;
262 extern SR_PRIV struct sr_dev_driver uni_t_ut61c_ser_driver_info;
263 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
264 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
265 extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
266 extern SR_PRIV struct sr_dev_driver tenma_72_7745_ser_driver_info;
267 extern SR_PRIV struct sr_dev_driver tenma_72_7750_ser_driver_info;
269 #ifdef HAVE_HW_UNI_T_DMM
270 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
271 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
272 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
273 extern SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
274 extern SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
275 extern SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
276 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
277 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
278 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
279 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
280 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
281 extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
282 extern SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
286 static struct sr_dev_driver *drivers_list[] = {
287 #ifdef HAVE_HW_APPA_55II
288 &appa_55ii_driver_info,
290 #ifdef HAVE_HW_ATTEN_PPS3XXX
291 &atten_pps3203_driver_info,
293 #ifdef HAVE_HW_BRYMEN_BM86X
294 &brymen_bm86x_driver_info,
296 #ifdef HAVE_HW_BRYMEN_DMM
297 &brymen_bm857_driver_info,
299 #ifdef HAVE_HW_CEM_DT_885X
300 &cem_dt_885x_driver_info,
302 #ifdef HAVE_HW_CENTER_3XX
303 ¢er_309_driver_info,
304 &voltcraft_k204_driver_info,
306 #ifdef HAVE_HW_COLEAD_SLM
307 &colead_slm_driver_info,
309 #ifdef HAVE_HW_CONRAD_DIGI_35_CPU
310 &conrad_digi_35_cpu_driver_info,
315 #ifdef HAVE_HW_GMC_MH_1X_2X
316 &gmc_mh_1x_2x_rs232_driver_info,
317 &gmc_mh_2x_bd232_driver_info,
319 #ifdef HAVE_HW_HAMEG_HMO
320 &hameg_hmo_driver_info,
322 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
323 &ikalogic_scanalogic2_driver_info,
325 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
326 &ikalogic_scanaplus_driver_info,
328 #ifdef HAVE_HW_KECHENG_KC_330B
329 &kecheng_kc_330b_driver_info,
331 #ifdef HAVE_HW_LASCAR_EL_USB
332 &lascar_el_usb_driver_info,
334 #ifdef HAVE_HW_MIC_985XX
335 &mic_98581_driver_info,
336 &mic_98583_driver_info,
338 #ifdef HAVE_HW_NORMA_DMM
339 &norma_dmm_driver_info,
344 #ifdef HAVE_HW_RIGOL_DS
345 &rigol_ds_driver_info,
347 #ifdef HAVE_HW_SALEAE_LOGIC16
348 &saleae_logic16_driver_info,
350 #ifdef HAVE_HW_SYSCLK_LWLA
351 &sysclk_lwla_driver_info,
353 #ifdef HAVE_HW_TELEINFO
354 &teleinfo_driver_info,
356 #ifdef HAVE_HW_TONDAJ_SL_814
357 &tondaj_sl_814_driver_info,
359 #ifdef HAVE_HW_UNI_T_UT32X
360 &uni_t_ut32x_driver_info,
362 #ifdef HAVE_HW_VICTOR_DMM
363 &victor_dmm_driver_info,
365 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
366 &zeroplus_logic_cube_driver_info,
368 #ifdef HAVE_HW_ASIX_SIGMA
369 &asix_sigma_driver_info,
371 #ifdef HAVE_HW_CHRONOVU_LA
372 &chronovu_la_driver_info,
374 #ifdef HAVE_HW_LINK_MSO19
375 &link_mso19_driver_info,
380 #ifdef HAVE_HW_FX2LAFW
381 &fx2lafw_driver_info,
383 #ifdef HAVE_HW_HANTEK_DSO
384 &hantek_dso_driver_info,
386 #ifdef HAVE_HW_AGILENT_DMM
389 #ifdef HAVE_HW_FLUKE_DMM
390 &flukedmm_driver_info,
392 #ifdef HAVE_HW_SERIAL_DMM
393 &bbcgm_m2110_driver_info,
394 &digitek_dt4000zc_driver_info,
395 &tekpower_tp4000zc_driver_info,
396 &metex_me31_driver_info,
397 &peaktech_3410_driver_info,
398 &mastech_mas345_driver_info,
399 &va_va18b_driver_info,
400 &va_va40b_driver_info,
401 &metex_m3640d_driver_info,
402 &metex_m4650cr_driver_info,
403 &peaktech_4370_driver_info,
404 &pce_pce_dm32_driver_info,
405 &radioshack_22_168_driver_info,
406 &radioshack_22_805_driver_info,
407 &radioshack_22_812_driver_info,
408 &tecpel_dmm_8061_ser_driver_info,
409 &voltcraft_m3650cr_driver_info,
410 &voltcraft_m3650d_driver_info,
411 &voltcraft_m4650cr_driver_info,
412 &voltcraft_me42_driver_info,
413 &voltcraft_vc820_ser_driver_info,
414 &voltcraft_vc830_ser_driver_info,
415 &voltcraft_vc840_ser_driver_info,
416 &uni_t_ut60a_ser_driver_info,
417 &uni_t_ut60e_ser_driver_info,
418 &uni_t_ut60g_ser_driver_info,
419 &uni_t_ut61b_ser_driver_info,
420 &uni_t_ut61c_ser_driver_info,
421 &uni_t_ut61d_ser_driver_info,
422 &uni_t_ut61e_ser_driver_info,
423 &iso_tech_idm103n_driver_info,
424 &tenma_72_7745_ser_driver_info,
425 &tenma_72_7750_ser_driver_info,
427 #ifdef HAVE_HW_UNI_T_DMM
428 &tecpel_dmm_8061_driver_info,
429 &uni_t_ut60a_driver_info,
430 &uni_t_ut60e_driver_info,
431 &uni_t_ut60g_driver_info,
432 &uni_t_ut61b_driver_info,
433 &uni_t_ut61c_driver_info,
434 &uni_t_ut61d_driver_info,
435 &uni_t_ut61e_driver_info,
436 &voltcraft_vc820_driver_info,
437 &voltcraft_vc830_driver_info,
438 &voltcraft_vc840_driver_info,
439 &tenma_72_7745_driver_info,
440 &tenma_72_7750_driver_info,
446 * Return the list of supported hardware drivers.
448 * @return Pointer to the NULL-terminated list of hardware driver pointers.
450 SR_API struct sr_dev_driver **sr_driver_list(void)
457 * Initialize a hardware driver.
459 * This usually involves memory allocations and variable initializations
460 * within the driver, but _not_ scanning for attached devices.
461 * The API call sr_driver_scan() is used for that.
463 * @param ctx A libsigrok context object allocated by a previous call to
464 * sr_init(). Must not be NULL.
465 * @param driver The driver to initialize. This must be a pointer to one of
466 * the entries returned by sr_driver_list(). Must not be NULL.
468 * @retval SR_OK Success
469 * @retval SR_ERR_ARG Invalid parameter(s).
470 * @retval SR_ERR_BUG Internal errors.
471 * @retval other Another negative error code upon other errors.
473 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
478 sr_err("Invalid libsigrok context, can't initialize.");
483 sr_err("Invalid driver, can't initialize.");
487 sr_spew("Initializing driver '%s'.", driver->name);
488 if ((ret = driver->init(ctx)) < 0)
489 sr_err("Failed to initialize the driver: %d.", ret);
495 * Tell a hardware driver to scan for devices.
497 * In addition to the detection, the devices that are found are also
498 * initialized automatically. On some devices, this involves a firmware upload,
499 * or other such measures.
501 * The order in which the system is scanned for devices is not specified. The
502 * caller should not assume or rely on any specific order.
504 * Before calling sr_driver_scan(), the user must have previously initialized
505 * the driver by calling sr_driver_init().
507 * @param driver The driver that should scan. This must be a pointer to one of
508 * the entries returned by sr_driver_list(). Must not be NULL.
509 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
510 * scanner. Can be NULL/empty.
512 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
513 * found (or errors were encountered). This list must be freed by the
514 * caller using g_slist_free(), but without freeing the data pointed
517 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
522 sr_err("Invalid driver, can't scan for devices.");
527 sr_err("Driver not initialized, can't scan for devices.");
531 l = driver->scan(options);
533 sr_spew("Scan of '%s' found %d devices.", driver->name,
539 /** Call driver cleanup function for all drivers.
541 SR_PRIV void sr_hw_cleanup_all(void)
544 struct sr_dev_driver **drivers;
546 drivers = sr_driver_list();
547 for (i = 0; drivers[i]; i++) {
548 if (drivers[i]->cleanup)
549 drivers[i]->cleanup();
553 /** Allocate struct sr_config.
554 * A floating reference can be passed in for data.
557 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
559 struct sr_config *src;
561 if (!(src = g_try_malloc(sizeof(struct sr_config))))
564 src->data = g_variant_ref_sink(data);
569 /** Free struct sr_config.
572 SR_PRIV void sr_config_free(struct sr_config *src)
575 if (!src || !src->data) {
576 sr_err("%s: invalid data!", __func__);
580 g_variant_unref(src->data);
586 * Query value of a configuration key at the given driver or device instance.
588 * @param[in] driver The sr_dev_driver struct to query.
589 * @param[in] sdi (optional) If the key is specific to a device, this must
590 * contain a pointer to the struct sr_dev_inst to be checked.
591 * Otherwise it must be NULL.
592 * @param[in] cg The channel group on the device for which to list the
594 * @param[in] key The configuration key (SR_CONF_*).
595 * @param[in,out] data Pointer to a GVariant where the value will be stored.
596 * Must not be NULL. The caller is given ownership of the GVariant
597 * and must thus decrease the refcount after use. However if
598 * this function returns an error code, the field should be
599 * considered unused, and should not be unreferenced.
601 * @retval SR_OK Success.
602 * @retval SR_ERR Error.
603 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
604 * interpreted as an error by the caller; merely as an indication
605 * that it's not applicable.
607 SR_API int sr_config_get(const struct sr_dev_driver *driver,
608 const struct sr_dev_inst *sdi,
609 const struct sr_channel_group *cg,
610 int key, GVariant **data)
614 if (!driver || !data)
617 if (!driver->config_get)
620 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
621 /* Got a floating reference from the driver. Sink it here,
622 * caller will need to unref when done with it. */
623 g_variant_ref_sink(*data);
630 * Set value of a configuration key in a device instance.
632 * @param[in] sdi The device instance.
633 * @param[in] cg The channel group on the device for which to list the
635 * @param[in] key The configuration key (SR_CONF_*).
636 * @param data The new value for the key, as a GVariant with GVariantType
637 * appropriate to that key. A floating reference can be passed
638 * in; its refcount will be sunk and unreferenced after use.
640 * @retval SR_OK Success.
641 * @retval SR_ERR Error.
642 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
643 * interpreted as an error by the caller; merely as an indication
644 * that it's not applicable.
646 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
647 const struct sr_channel_group *cg,
648 int key, GVariant *data)
652 g_variant_ref_sink(data);
654 if (!sdi || !sdi->driver || !data)
656 else if (!sdi->driver->config_set)
659 ret = sdi->driver->config_set(key, data, sdi, cg);
661 g_variant_unref(data);
667 * Apply configuration settings to the device hardware.
669 * @param sdi The device instance.
671 * @return SR_OK upon success or SR_ERR in case of error.
673 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
677 if (!sdi || !sdi->driver)
679 else if (!sdi->driver->config_commit)
682 ret = sdi->driver->config_commit(sdi);
688 * List all possible values for a configuration key.
690 * @param[in] driver The sr_dev_driver struct to query.
691 * @param[in] sdi (optional) If the key is specific to a device, this must
692 * contain a pointer to the struct sr_dev_inst to be checked.
693 * @param[in] cg The channel group on the device for which to list the
695 * @param[in] key The configuration key (SR_CONF_*).
696 * @param[in,out] data A pointer to a GVariant where the list will be stored.
697 * The caller is given ownership of the GVariant and must thus
698 * unref the GVariant after use. However if this function
699 * returns an error code, the field should be considered
700 * unused, and should not be unreferenced.
702 * @retval SR_OK Success.
703 * @retval SR_ERR Error.
704 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
705 * interpreted as an error by the caller; merely as an indication
706 * that it's not applicable.
708 SR_API int sr_config_list(const struct sr_dev_driver *driver,
709 const struct sr_dev_inst *sdi,
710 const struct sr_channel_group *cg,
711 int key, GVariant **data)
715 if (!driver || !data)
717 else if (!driver->config_list)
719 else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
720 g_variant_ref_sink(*data);
726 * Get information about a configuration key, by key.
728 * @param[in] key The configuration key.
730 * @return A pointer to a struct sr_config_info, or NULL if the key
733 SR_API const struct sr_config_info *sr_config_info_get(int key)
737 for (i = 0; sr_config_info_data[i].key; i++) {
738 if (sr_config_info_data[i].key == key)
739 return &sr_config_info_data[i];
746 * Get information about a configuration key, by name.
748 * @param[in] optname The configuration key.
750 * @return A pointer to a struct sr_config_info, or NULL if the key
753 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
757 for (i = 0; sr_config_info_data[i].key; i++) {
758 if (!strcmp(sr_config_info_data[i].id, optname))
759 return &sr_config_info_data[i];
765 /* Unnecessary level of indirection follows. */
768 * @see sr_session_source_remove()
770 SR_PRIV int sr_source_remove(int fd)
772 return sr_session_source_remove(fd);
776 * @see sr_session_source_add()
778 SR_PRIV int sr_source_add(int fd, int events, int timeout,
779 sr_receive_data_callback_t cb, void *cb_data)
781 return sr_session_source_add(fd, events, timeout, cb, cb_data);