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_STRING, "conn",
51 {SR_CONF_SERIALCOMM, SR_T_STRING, "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_STRING, "pattern",
59 {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
60 "Trigger matches", 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_STRING, "triggerslope",
68 "Trigger slope", NULL},
69 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "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_STRING, "filter",
78 "Filter targets", NULL},
79 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
81 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
83 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
85 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
86 "Sound pressure level frequency weighting", NULL},
87 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "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_STRING, "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_STRING, "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_STRING, "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_MOTECH_LPS_30X
181 extern SR_PRIV struct sr_dev_driver motech_lps_301_driver_info;
183 #ifdef HAVE_HW_NORMA_DMM
184 extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
185 extern SR_PRIV struct sr_dev_driver siemens_b102x_driver_info;
188 extern SR_PRIV struct sr_dev_driver ols_driver_info;
190 #ifdef HAVE_HW_RIGOL_DS
191 extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
193 #ifdef HAVE_HW_SALEAE_LOGIC16
194 extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
196 #ifdef HAVE_HW_SYSCLK_LWLA
197 extern SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
199 #ifdef HAVE_HW_TELEINFO
200 extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
202 #ifdef HAVE_HW_TONDAJ_SL_814
203 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
205 #ifdef HAVE_HW_UNI_T_UT32X
206 extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
208 #ifdef HAVE_HW_VICTOR_DMM
209 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
211 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
212 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
214 #ifdef HAVE_HW_ASIX_SIGMA
215 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
217 #ifdef HAVE_HW_CHRONOVU_LA
218 extern SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
220 #ifdef HAVE_HW_LINK_MSO19
221 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
223 #ifdef HAVE_HW_FX2LAFW
224 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
226 #ifdef HAVE_HW_HANTEK_DSO
227 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
229 #ifdef HAVE_HW_AGILENT_DMM
230 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
232 #ifdef HAVE_HW_FLUKE_DMM
233 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
235 #ifdef HAVE_HW_SERIAL_DMM
236 extern SR_PRIV struct sr_dev_driver bbcgm_m2110_driver_info;
237 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
238 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
239 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
240 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
241 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
242 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
243 extern SR_PRIV struct sr_dev_driver va_va40b_driver_info;
244 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
245 extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
246 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
247 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
248 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
249 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
250 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
251 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
252 extern SR_PRIV struct sr_dev_driver voltcraft_m3650cr_driver_info;
253 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
254 extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
255 extern SR_PRIV struct sr_dev_driver voltcraft_me42_driver_info;
256 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
257 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
258 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
259 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
260 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
261 extern SR_PRIV struct sr_dev_driver uni_t_ut60g_ser_driver_info;
262 extern SR_PRIV struct sr_dev_driver uni_t_ut61b_ser_driver_info;
263 extern SR_PRIV struct sr_dev_driver uni_t_ut61c_ser_driver_info;
264 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
265 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
266 extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
267 extern SR_PRIV struct sr_dev_driver tenma_72_7745_ser_driver_info;
268 extern SR_PRIV struct sr_dev_driver tenma_72_7750_ser_driver_info;
270 #ifdef HAVE_HW_UNI_T_DMM
271 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
272 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
273 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
274 extern SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
275 extern SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
276 extern SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
277 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
278 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
279 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
280 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
281 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
282 extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
283 extern SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
287 static struct sr_dev_driver *drivers_list[] = {
288 #ifdef HAVE_HW_APPA_55II
289 &appa_55ii_driver_info,
291 #ifdef HAVE_HW_ATTEN_PPS3XXX
292 &atten_pps3203_driver_info,
294 #ifdef HAVE_HW_BRYMEN_BM86X
295 &brymen_bm86x_driver_info,
297 #ifdef HAVE_HW_BRYMEN_DMM
298 &brymen_bm857_driver_info,
300 #ifdef HAVE_HW_CEM_DT_885X
301 &cem_dt_885x_driver_info,
303 #ifdef HAVE_HW_CENTER_3XX
304 ¢er_309_driver_info,
305 &voltcraft_k204_driver_info,
307 #ifdef HAVE_HW_COLEAD_SLM
308 &colead_slm_driver_info,
310 #ifdef HAVE_HW_CONRAD_DIGI_35_CPU
311 &conrad_digi_35_cpu_driver_info,
316 #ifdef HAVE_HW_GMC_MH_1X_2X
317 &gmc_mh_1x_2x_rs232_driver_info,
318 &gmc_mh_2x_bd232_driver_info,
320 #ifdef HAVE_HW_HAMEG_HMO
321 &hameg_hmo_driver_info,
323 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
324 &ikalogic_scanalogic2_driver_info,
326 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
327 &ikalogic_scanaplus_driver_info,
329 #ifdef HAVE_HW_KECHENG_KC_330B
330 &kecheng_kc_330b_driver_info,
332 #ifdef HAVE_HW_LASCAR_EL_USB
333 &lascar_el_usb_driver_info,
335 #ifdef HAVE_HW_MIC_985XX
336 &mic_98581_driver_info,
337 &mic_98583_driver_info,
339 #ifdef HAVE_HW_MOTECH_LPS_30X
340 &motech_lps_301_driver_info,
342 #ifdef HAVE_HW_NORMA_DMM
343 &norma_dmm_driver_info,
344 &siemens_b102x_driver_info,
349 #ifdef HAVE_HW_RIGOL_DS
350 &rigol_ds_driver_info,
352 #ifdef HAVE_HW_SALEAE_LOGIC16
353 &saleae_logic16_driver_info,
355 #ifdef HAVE_HW_SYSCLK_LWLA
356 &sysclk_lwla_driver_info,
358 #ifdef HAVE_HW_TELEINFO
359 &teleinfo_driver_info,
361 #ifdef HAVE_HW_TONDAJ_SL_814
362 &tondaj_sl_814_driver_info,
364 #ifdef HAVE_HW_UNI_T_UT32X
365 &uni_t_ut32x_driver_info,
367 #ifdef HAVE_HW_VICTOR_DMM
368 &victor_dmm_driver_info,
370 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
371 &zeroplus_logic_cube_driver_info,
373 #ifdef HAVE_HW_ASIX_SIGMA
374 &asix_sigma_driver_info,
376 #ifdef HAVE_HW_CHRONOVU_LA
377 &chronovu_la_driver_info,
379 #ifdef HAVE_HW_LINK_MSO19
380 &link_mso19_driver_info,
382 #ifdef HAVE_HW_FX2LAFW
383 &fx2lafw_driver_info,
385 #ifdef HAVE_HW_HANTEK_DSO
386 &hantek_dso_driver_info,
388 #ifdef HAVE_HW_AGILENT_DMM
391 #ifdef HAVE_HW_FLUKE_DMM
392 &flukedmm_driver_info,
394 #ifdef HAVE_HW_SERIAL_DMM
395 &bbcgm_m2110_driver_info,
396 &digitek_dt4000zc_driver_info,
397 &tekpower_tp4000zc_driver_info,
398 &metex_me31_driver_info,
399 &peaktech_3410_driver_info,
400 &mastech_mas345_driver_info,
401 &va_va18b_driver_info,
402 &va_va40b_driver_info,
403 &metex_m3640d_driver_info,
404 &metex_m4650cr_driver_info,
405 &peaktech_4370_driver_info,
406 &pce_pce_dm32_driver_info,
407 &radioshack_22_168_driver_info,
408 &radioshack_22_805_driver_info,
409 &radioshack_22_812_driver_info,
410 &tecpel_dmm_8061_ser_driver_info,
411 &voltcraft_m3650cr_driver_info,
412 &voltcraft_m3650d_driver_info,
413 &voltcraft_m4650cr_driver_info,
414 &voltcraft_me42_driver_info,
415 &voltcraft_vc820_ser_driver_info,
416 &voltcraft_vc830_ser_driver_info,
417 &voltcraft_vc840_ser_driver_info,
418 &uni_t_ut60a_ser_driver_info,
419 &uni_t_ut60e_ser_driver_info,
420 &uni_t_ut60g_ser_driver_info,
421 &uni_t_ut61b_ser_driver_info,
422 &uni_t_ut61c_ser_driver_info,
423 &uni_t_ut61d_ser_driver_info,
424 &uni_t_ut61e_ser_driver_info,
425 &iso_tech_idm103n_driver_info,
426 &tenma_72_7745_ser_driver_info,
427 &tenma_72_7750_ser_driver_info,
429 #ifdef HAVE_HW_UNI_T_DMM
430 &tecpel_dmm_8061_driver_info,
431 &uni_t_ut60a_driver_info,
432 &uni_t_ut60e_driver_info,
433 &uni_t_ut60g_driver_info,
434 &uni_t_ut61b_driver_info,
435 &uni_t_ut61c_driver_info,
436 &uni_t_ut61d_driver_info,
437 &uni_t_ut61e_driver_info,
438 &voltcraft_vc820_driver_info,
439 &voltcraft_vc830_driver_info,
440 &voltcraft_vc840_driver_info,
441 &tenma_72_7745_driver_info,
442 &tenma_72_7750_driver_info,
448 * Return the list of supported hardware drivers.
450 * @return Pointer to the NULL-terminated list of hardware driver pointers.
454 SR_API struct sr_dev_driver **sr_driver_list(void)
461 * Initialize a hardware driver.
463 * This usually involves memory allocations and variable initializations
464 * within the driver, but _not_ scanning for attached devices.
465 * The API call sr_driver_scan() is used for that.
467 * @param ctx A libsigrok context object allocated by a previous call to
468 * sr_init(). Must not be NULL.
469 * @param driver The driver to initialize. This must be a pointer to one of
470 * the entries returned by sr_driver_list(). Must not be NULL.
472 * @retval SR_OK Success
473 * @retval SR_ERR_ARG Invalid parameter(s).
474 * @retval SR_ERR_BUG Internal errors.
475 * @retval other Another negative error code upon other errors.
479 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
484 sr_err("Invalid libsigrok context, can't initialize.");
489 sr_err("Invalid driver, can't initialize.");
493 sr_spew("Initializing driver '%s'.", driver->name);
494 if ((ret = driver->init(ctx)) < 0)
495 sr_err("Failed to initialize the driver: %d.", ret);
501 * Tell a hardware driver to scan for devices.
503 * In addition to the detection, the devices that are found are also
504 * initialized automatically. On some devices, this involves a firmware upload,
505 * or other such measures.
507 * The order in which the system is scanned for devices is not specified. The
508 * caller should not assume or rely on any specific order.
510 * Before calling sr_driver_scan(), the user must have previously initialized
511 * the driver by calling sr_driver_init().
513 * @param driver The driver that should scan. This must be a pointer to one of
514 * the entries returned by sr_driver_list(). Must not be NULL.
515 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
516 * scanner. Can be NULL/empty.
518 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
519 * found (or errors were encountered). This list must be freed by the
520 * caller using g_slist_free(), but without freeing the data pointed
525 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
530 sr_err("Invalid driver, can't scan for devices.");
535 sr_err("Driver not initialized, can't scan for devices.");
539 l = driver->scan(options);
541 sr_spew("Scan of '%s' found %d devices.", driver->name,
547 /** Call driver cleanup function for all drivers.
549 SR_PRIV void sr_hw_cleanup_all(void)
552 struct sr_dev_driver **drivers;
554 drivers = sr_driver_list();
555 for (i = 0; drivers[i]; i++) {
556 if (drivers[i]->cleanup)
557 drivers[i]->cleanup();
561 /** Allocate struct sr_config.
562 * A floating reference can be passed in for data.
565 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
567 struct sr_config *src;
569 if (!(src = g_try_malloc(sizeof(struct sr_config))))
572 src->data = g_variant_ref_sink(data);
577 /** Free struct sr_config.
580 SR_PRIV void sr_config_free(struct sr_config *src)
583 if (!src || !src->data) {
584 sr_err("%s: invalid data!", __func__);
588 g_variant_unref(src->data);
594 * Query value of a configuration key at the given driver or device instance.
596 * @param[in] driver The sr_dev_driver struct to query.
597 * @param[in] sdi (optional) If the key is specific to a device, this must
598 * contain a pointer to the struct sr_dev_inst to be checked.
599 * Otherwise it must be NULL.
600 * @param[in] cg The channel group on the device for which to list the
602 * @param[in] key The configuration key (SR_CONF_*).
603 * @param[in,out] data Pointer to a GVariant where the value will be stored.
604 * Must not be NULL. The caller is given ownership of the GVariant
605 * and must thus decrease the refcount after use. However if
606 * this function returns an error code, the field should be
607 * considered unused, and should not be unreferenced.
609 * @retval SR_OK Success.
610 * @retval SR_ERR Error.
611 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
612 * interpreted as an error by the caller; merely as an indication
613 * that it's not applicable.
617 SR_API int sr_config_get(const struct sr_dev_driver *driver,
618 const struct sr_dev_inst *sdi,
619 const struct sr_channel_group *cg,
620 int key, GVariant **data)
624 if (!driver || !data)
627 if (!driver->config_get)
630 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
631 /* Got a floating reference from the driver. Sink it here,
632 * caller will need to unref when done with it. */
633 g_variant_ref_sink(*data);
640 * Set value of a configuration key in a device instance.
642 * @param[in] sdi The device instance.
643 * @param[in] cg The channel group on the device for which to list the
645 * @param[in] key The configuration key (SR_CONF_*).
646 * @param data The new value for the key, as a GVariant with GVariantType
647 * appropriate to that key. A floating reference can be passed
648 * in; its refcount will be sunk and unreferenced after use.
650 * @retval SR_OK Success.
651 * @retval SR_ERR Error.
652 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
653 * interpreted as an error by the caller; merely as an indication
654 * that it's not applicable.
658 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
659 const struct sr_channel_group *cg,
660 int key, GVariant *data)
664 g_variant_ref_sink(data);
666 if (!sdi || !sdi->driver || !data)
668 else if (!sdi->driver->config_set)
671 ret = sdi->driver->config_set(key, data, sdi, cg);
673 g_variant_unref(data);
679 * Apply configuration settings to the device hardware.
681 * @param sdi The device instance.
683 * @return SR_OK upon success or SR_ERR in case of error.
687 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
691 if (!sdi || !sdi->driver)
693 else if (!sdi->driver->config_commit)
696 ret = sdi->driver->config_commit(sdi);
702 * List all possible values for a configuration key.
704 * @param[in] driver The sr_dev_driver struct to query.
705 * @param[in] sdi (optional) If the key is specific to a device, this must
706 * contain a pointer to the struct sr_dev_inst to be checked.
707 * @param[in] cg The channel group on the device for which to list the
709 * @param[in] key The configuration key (SR_CONF_*).
710 * @param[in,out] data A pointer to a GVariant where the list will be stored.
711 * The caller is given ownership of the GVariant and must thus
712 * unref the GVariant after use. However if this function
713 * returns an error code, the field should be considered
714 * unused, and should not be unreferenced.
716 * @retval SR_OK Success.
717 * @retval SR_ERR Error.
718 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
719 * interpreted as an error by the caller; merely as an indication
720 * that it's not applicable.
724 SR_API int sr_config_list(const struct sr_dev_driver *driver,
725 const struct sr_dev_inst *sdi,
726 const struct sr_channel_group *cg,
727 int key, GVariant **data)
731 if (!driver || !data)
733 else if (!driver->config_list)
735 else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
736 g_variant_ref_sink(*data);
742 * Get information about a configuration key, by key.
744 * @param[in] key The configuration key.
746 * @return A pointer to a struct sr_config_info, or NULL if the key
751 SR_API const struct sr_config_info *sr_config_info_get(int key)
755 for (i = 0; sr_config_info_data[i].key; i++) {
756 if (sr_config_info_data[i].key == key)
757 return &sr_config_info_data[i];
764 * Get information about a configuration key, by name.
766 * @param[in] optname The configuration key.
768 * @return A pointer to a struct sr_config_info, or NULL if the key
773 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
777 for (i = 0; sr_config_info_data[i].key; i++) {
778 if (!strcmp(sr_config_info_data[i].id, optname))
779 return &sr_config_info_data[i];
785 /* Unnecessary level of indirection follows. */
788 * @see sr_session_source_remove()
790 SR_PRIV int sr_source_remove(int fd)
792 return sr_session_source_remove(fd);
796 * @see sr_session_source_add()
798 SR_PRIV int sr_source_add(int fd, int events, int timeout,
799 sr_receive_data_callback cb, void *cb_data)
801 return sr_session_source_add(fd, events, timeout, cb, cb_data);