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;
219 #ifdef HAVE_HW_FX2LAFW
220 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
222 #ifdef HAVE_HW_HANTEK_DSO
223 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
225 #ifdef HAVE_HW_AGILENT_DMM
226 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
228 #ifdef HAVE_HW_FLUKE_DMM
229 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
231 #ifdef HAVE_HW_SERIAL_DMM
232 extern SR_PRIV struct sr_dev_driver bbcgm_m2110_driver_info;
233 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
234 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
235 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
236 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
237 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
238 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
239 extern SR_PRIV struct sr_dev_driver va_va40b_driver_info;
240 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
241 extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
242 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
243 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
244 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
245 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
246 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
247 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
248 extern SR_PRIV struct sr_dev_driver voltcraft_m3650cr_driver_info;
249 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
250 extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
251 extern SR_PRIV struct sr_dev_driver voltcraft_me42_driver_info;
252 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
253 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
254 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
255 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
256 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
257 extern SR_PRIV struct sr_dev_driver uni_t_ut60g_ser_driver_info;
258 extern SR_PRIV struct sr_dev_driver uni_t_ut61b_ser_driver_info;
259 extern SR_PRIV struct sr_dev_driver uni_t_ut61c_ser_driver_info;
260 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
261 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
262 extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
263 extern SR_PRIV struct sr_dev_driver tenma_72_7745_ser_driver_info;
264 extern SR_PRIV struct sr_dev_driver tenma_72_7750_ser_driver_info;
266 #ifdef HAVE_HW_UNI_T_DMM
267 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
268 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
269 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
270 extern SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
271 extern SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
272 extern SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
273 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
274 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
275 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
276 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
277 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
278 extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
279 extern SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
283 static struct sr_dev_driver *drivers_list[] = {
284 #ifdef HAVE_HW_APPA_55II
285 &appa_55ii_driver_info,
287 #ifdef HAVE_HW_ATTEN_PPS3XXX
288 &atten_pps3203_driver_info,
290 #ifdef HAVE_HW_BRYMEN_BM86X
291 &brymen_bm86x_driver_info,
293 #ifdef HAVE_HW_BRYMEN_DMM
294 &brymen_bm857_driver_info,
296 #ifdef HAVE_HW_CEM_DT_885X
297 &cem_dt_885x_driver_info,
299 #ifdef HAVE_HW_CENTER_3XX
300 ¢er_309_driver_info,
301 &voltcraft_k204_driver_info,
303 #ifdef HAVE_HW_COLEAD_SLM
304 &colead_slm_driver_info,
306 #ifdef HAVE_HW_CONRAD_DIGI_35_CPU
307 &conrad_digi_35_cpu_driver_info,
312 #ifdef HAVE_HW_GMC_MH_1X_2X
313 &gmc_mh_1x_2x_rs232_driver_info,
314 &gmc_mh_2x_bd232_driver_info,
316 #ifdef HAVE_HW_HAMEG_HMO
317 &hameg_hmo_driver_info,
319 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
320 &ikalogic_scanalogic2_driver_info,
322 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
323 &ikalogic_scanaplus_driver_info,
325 #ifdef HAVE_HW_KECHENG_KC_330B
326 &kecheng_kc_330b_driver_info,
328 #ifdef HAVE_HW_LASCAR_EL_USB
329 &lascar_el_usb_driver_info,
331 #ifdef HAVE_HW_MIC_985XX
332 &mic_98581_driver_info,
333 &mic_98583_driver_info,
335 #ifdef HAVE_HW_NORMA_DMM
336 &norma_dmm_driver_info,
341 #ifdef HAVE_HW_RIGOL_DS
342 &rigol_ds_driver_info,
344 #ifdef HAVE_HW_SALEAE_LOGIC16
345 &saleae_logic16_driver_info,
347 #ifdef HAVE_HW_SYSCLK_LWLA
348 &sysclk_lwla_driver_info,
350 #ifdef HAVE_HW_TELEINFO
351 &teleinfo_driver_info,
353 #ifdef HAVE_HW_TONDAJ_SL_814
354 &tondaj_sl_814_driver_info,
356 #ifdef HAVE_HW_UNI_T_UT32X
357 &uni_t_ut32x_driver_info,
359 #ifdef HAVE_HW_VICTOR_DMM
360 &victor_dmm_driver_info,
362 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
363 &zeroplus_logic_cube_driver_info,
365 #ifdef HAVE_HW_ASIX_SIGMA
366 &asix_sigma_driver_info,
368 #ifdef HAVE_HW_CHRONOVU_LA
369 &chronovu_la_driver_info,
371 #ifdef HAVE_HW_LINK_MSO19
372 &link_mso19_driver_info,
374 #ifdef HAVE_HW_FX2LAFW
375 &fx2lafw_driver_info,
377 #ifdef HAVE_HW_HANTEK_DSO
378 &hantek_dso_driver_info,
380 #ifdef HAVE_HW_AGILENT_DMM
383 #ifdef HAVE_HW_FLUKE_DMM
384 &flukedmm_driver_info,
386 #ifdef HAVE_HW_SERIAL_DMM
387 &bbcgm_m2110_driver_info,
388 &digitek_dt4000zc_driver_info,
389 &tekpower_tp4000zc_driver_info,
390 &metex_me31_driver_info,
391 &peaktech_3410_driver_info,
392 &mastech_mas345_driver_info,
393 &va_va18b_driver_info,
394 &va_va40b_driver_info,
395 &metex_m3640d_driver_info,
396 &metex_m4650cr_driver_info,
397 &peaktech_4370_driver_info,
398 &pce_pce_dm32_driver_info,
399 &radioshack_22_168_driver_info,
400 &radioshack_22_805_driver_info,
401 &radioshack_22_812_driver_info,
402 &tecpel_dmm_8061_ser_driver_info,
403 &voltcraft_m3650cr_driver_info,
404 &voltcraft_m3650d_driver_info,
405 &voltcraft_m4650cr_driver_info,
406 &voltcraft_me42_driver_info,
407 &voltcraft_vc820_ser_driver_info,
408 &voltcraft_vc830_ser_driver_info,
409 &voltcraft_vc840_ser_driver_info,
410 &uni_t_ut60a_ser_driver_info,
411 &uni_t_ut60e_ser_driver_info,
412 &uni_t_ut60g_ser_driver_info,
413 &uni_t_ut61b_ser_driver_info,
414 &uni_t_ut61c_ser_driver_info,
415 &uni_t_ut61d_ser_driver_info,
416 &uni_t_ut61e_ser_driver_info,
417 &iso_tech_idm103n_driver_info,
418 &tenma_72_7745_ser_driver_info,
419 &tenma_72_7750_ser_driver_info,
421 #ifdef HAVE_HW_UNI_T_DMM
422 &tecpel_dmm_8061_driver_info,
423 &uni_t_ut60a_driver_info,
424 &uni_t_ut60e_driver_info,
425 &uni_t_ut60g_driver_info,
426 &uni_t_ut61b_driver_info,
427 &uni_t_ut61c_driver_info,
428 &uni_t_ut61d_driver_info,
429 &uni_t_ut61e_driver_info,
430 &voltcraft_vc820_driver_info,
431 &voltcraft_vc830_driver_info,
432 &voltcraft_vc840_driver_info,
433 &tenma_72_7745_driver_info,
434 &tenma_72_7750_driver_info,
440 * Return the list of supported hardware drivers.
442 * @return Pointer to the NULL-terminated list of hardware driver pointers.
444 SR_API struct sr_dev_driver **sr_driver_list(void)
451 * Initialize a hardware driver.
453 * This usually involves memory allocations and variable initializations
454 * within the driver, but _not_ scanning for attached devices.
455 * The API call sr_driver_scan() is used for that.
457 * @param ctx A libsigrok context object allocated by a previous call to
458 * sr_init(). Must not be NULL.
459 * @param driver The driver to initialize. This must be a pointer to one of
460 * the entries returned by sr_driver_list(). Must not be NULL.
462 * @retval SR_OK Success
463 * @retval SR_ERR_ARG Invalid parameter(s).
464 * @retval SR_ERR_BUG Internal errors.
465 * @retval other Another negative error code upon other errors.
467 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
472 sr_err("Invalid libsigrok context, can't initialize.");
477 sr_err("Invalid driver, can't initialize.");
481 sr_spew("Initializing driver '%s'.", driver->name);
482 if ((ret = driver->init(ctx)) < 0)
483 sr_err("Failed to initialize the driver: %d.", ret);
489 * Tell a hardware driver to scan for devices.
491 * In addition to the detection, the devices that are found are also
492 * initialized automatically. On some devices, this involves a firmware upload,
493 * or other such measures.
495 * The order in which the system is scanned for devices is not specified. The
496 * caller should not assume or rely on any specific order.
498 * Before calling sr_driver_scan(), the user must have previously initialized
499 * the driver by calling sr_driver_init().
501 * @param driver The driver that should scan. This must be a pointer to one of
502 * the entries returned by sr_driver_list(). Must not be NULL.
503 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
504 * scanner. Can be NULL/empty.
506 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
507 * found (or errors were encountered). This list must be freed by the
508 * caller using g_slist_free(), but without freeing the data pointed
511 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
516 sr_err("Invalid driver, can't scan for devices.");
521 sr_err("Driver not initialized, can't scan for devices.");
525 l = driver->scan(options);
527 sr_spew("Scan of '%s' found %d devices.", driver->name,
533 /** Call driver cleanup function for all drivers.
535 SR_PRIV void sr_hw_cleanup_all(void)
538 struct sr_dev_driver **drivers;
540 drivers = sr_driver_list();
541 for (i = 0; drivers[i]; i++) {
542 if (drivers[i]->cleanup)
543 drivers[i]->cleanup();
547 /** Allocate struct sr_config.
548 * A floating reference can be passed in for data.
551 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
553 struct sr_config *src;
555 if (!(src = g_try_malloc(sizeof(struct sr_config))))
558 src->data = g_variant_ref_sink(data);
563 /** Free struct sr_config.
566 SR_PRIV void sr_config_free(struct sr_config *src)
569 if (!src || !src->data) {
570 sr_err("%s: invalid data!", __func__);
574 g_variant_unref(src->data);
580 * Query value of a configuration key at the given driver or device instance.
582 * @param[in] driver The sr_dev_driver struct to query.
583 * @param[in] sdi (optional) If the key is specific to a device, this must
584 * contain a pointer to the struct sr_dev_inst to be checked.
585 * Otherwise it must be NULL.
586 * @param[in] cg The channel group on the device for which to list the
588 * @param[in] key The configuration key (SR_CONF_*).
589 * @param[in,out] data Pointer to a GVariant where the value will be stored.
590 * Must not be NULL. The caller is given ownership of the GVariant
591 * and must thus decrease the refcount after use. However if
592 * this function returns an error code, the field should be
593 * considered unused, and should not be unreferenced.
595 * @retval SR_OK Success.
596 * @retval SR_ERR Error.
597 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
598 * interpreted as an error by the caller; merely as an indication
599 * that it's not applicable.
601 SR_API int sr_config_get(const struct sr_dev_driver *driver,
602 const struct sr_dev_inst *sdi,
603 const struct sr_channel_group *cg,
604 int key, GVariant **data)
608 if (!driver || !data)
611 if (!driver->config_get)
614 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
615 /* Got a floating reference from the driver. Sink it here,
616 * caller will need to unref when done with it. */
617 g_variant_ref_sink(*data);
624 * Set value of a configuration key in a device instance.
626 * @param[in] sdi The device instance.
627 * @param[in] cg The channel group on the device for which to list the
629 * @param[in] key The configuration key (SR_CONF_*).
630 * @param data The new value for the key, as a GVariant with GVariantType
631 * appropriate to that key. A floating reference can be passed
632 * in; its refcount will be sunk and unreferenced after use.
634 * @retval SR_OK Success.
635 * @retval SR_ERR Error.
636 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
637 * interpreted as an error by the caller; merely as an indication
638 * that it's not applicable.
640 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
641 const struct sr_channel_group *cg,
642 int key, GVariant *data)
646 g_variant_ref_sink(data);
648 if (!sdi || !sdi->driver || !data)
650 else if (!sdi->driver->config_set)
653 ret = sdi->driver->config_set(key, data, sdi, cg);
655 g_variant_unref(data);
661 * Apply configuration settings to the device hardware.
663 * @param sdi The device instance.
665 * @return SR_OK upon success or SR_ERR in case of error.
667 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
671 if (!sdi || !sdi->driver)
673 else if (!sdi->driver->config_commit)
676 ret = sdi->driver->config_commit(sdi);
682 * List all possible values for a configuration key.
684 * @param[in] driver The sr_dev_driver struct to query.
685 * @param[in] sdi (optional) If the key is specific to a device, this must
686 * contain a pointer to the struct sr_dev_inst to be checked.
687 * @param[in] cg The channel group on the device for which to list the
689 * @param[in] key The configuration key (SR_CONF_*).
690 * @param[in,out] data A pointer to a GVariant where the list will be stored.
691 * The caller is given ownership of the GVariant and must thus
692 * unref the GVariant after use. However if this function
693 * returns an error code, the field should be considered
694 * unused, and should not be unreferenced.
696 * @retval SR_OK Success.
697 * @retval SR_ERR Error.
698 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
699 * interpreted as an error by the caller; merely as an indication
700 * that it's not applicable.
702 SR_API int sr_config_list(const struct sr_dev_driver *driver,
703 const struct sr_dev_inst *sdi,
704 const struct sr_channel_group *cg,
705 int key, GVariant **data)
709 if (!driver || !data)
711 else if (!driver->config_list)
713 else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
714 g_variant_ref_sink(*data);
720 * Get information about a configuration key, by key.
722 * @param[in] key The configuration key.
724 * @return A pointer to a struct sr_config_info, or NULL if the key
727 SR_API const struct sr_config_info *sr_config_info_get(int key)
731 for (i = 0; sr_config_info_data[i].key; i++) {
732 if (sr_config_info_data[i].key == key)
733 return &sr_config_info_data[i];
740 * Get information about a configuration key, by name.
742 * @param[in] optname The configuration key.
744 * @return A pointer to a struct sr_config_info, or NULL if the key
747 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
751 for (i = 0; sr_config_info_data[i].key; i++) {
752 if (!strcmp(sr_config_info_data[i].id, optname))
753 return &sr_config_info_data[i];
759 /* Unnecessary level of indirection follows. */
762 * @see sr_session_source_remove()
764 SR_PRIV int sr_source_remove(int fd)
766 return sr_session_source_remove(fd);
770 * @see sr_session_source_add()
772 SR_PRIV int sr_source_add(int fd, int events, int timeout,
773 sr_receive_data_callback cb, void *cb_data)
775 return sr_session_source_add(fd, events, timeout, cb, cb_data);