]> sigrok.org Git - libsigrok.git/blame_incremental - hwdriver.c
projects / libsigrok.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Rename rigol-ds1xx2 driver to rigol-ds.
[libsigrok.git] / hwdriver.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
20#include <stdlib.h>
21#include <stdio.h>
22#include <sys/types.h>
23#include <dirent.h>
24#include <string.h>
25#include <glib.h>
26#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
27#include "libsigrok.h"
28#include "libsigrok-internal.h"
29
30/* Message logging helpers with subsystem-specific prefix string. */
31#define LOG_PREFIX "hwdriver: "
32#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
33#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
34#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
35#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
36#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
37#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
38
39/**
40 * @file
41 *
42 * Hardware driver handling in libsigrok.
43 */
44
45/**
46 * @defgroup grp_driver Hardware drivers
47 *
48 * Hardware driver handling in libsigrok.
49 *
50 * @{
51 */
52
53static struct sr_config_info sr_config_info_data[] = {
54 {SR_CONF_CONN, SR_T_CHAR, "conn",
55 "Connection", NULL},
56 {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
57 "Serial communication", NULL},
58 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
59 "Sample rate", NULL},
60 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
61 "Pre-trigger capture ratio", NULL},
62 {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
63 "Pattern generator mode", NULL},
64 {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
65 "Trigger types", NULL},
66 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
67 "External clock mode", NULL},
68 {SR_CONF_SWAP, SR_T_BOOL, "swap",
69 "Swap channel order", NULL},
70 {SR_CONF_RLE, SR_T_BOOL, "rle",
71 "Run Length Encoding", NULL},
72 {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
73 "Trigger slope", NULL},
74 {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
75 "Trigger source", NULL},
76 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
77 "Horizontal trigger position", NULL},
78 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
79 "Buffer size", NULL},
80 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
81 "Time base", NULL},
82 {SR_CONF_FILTER, SR_T_CHAR, "filter",
83 "Filter targets", NULL},
84 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
85 "Volts/div", NULL},
86 {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
87 "Coupling", NULL},
88 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
89 "Datalog", NULL},
90 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq",
91 "Sound pressure level frequency weighting", NULL},
92 {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time",
93 "Sound pressure level time weighting", NULL},
94 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
95 "Hold max", NULL},
96 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
97 "Hold min", NULL},
98 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
99 "Sound pressure level measurement range", NULL},
100 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
101 "Voltage threshold", NULL },
102 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
103 "Power off", NULL},
104 {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
105 "Data source", NULL},
106 {0, 0, NULL, NULL, NULL},
107};
108
109/** @cond PRIVATE */
110#ifdef HAVE_HW_BRYMEN_DMM
111extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
112#endif
113#ifdef HAVE_HW_CEM_DT_885X
114extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
115#endif
116#ifdef HAVE_HW_CENTER_3XX
117extern SR_PRIV struct sr_dev_driver center_309_driver_info;
118extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
119#endif
120#ifdef HAVE_HW_COLEAD_SLM
121extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
122#endif
123#ifdef HAVE_HW_DEMO
124extern SR_PRIV struct sr_dev_driver demo_driver_info;
125#endif
126#ifdef HAVE_HW_GMC_MH_1X_2X
127extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
128#endif
129#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
130extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
131#endif
132#ifdef HAVE_HW_IKALOGIC_SCANAPLUS
133extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
134#endif
135#ifdef HAVE_HW_KECHENG_KC_330B
136extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
137#endif
138#ifdef HAVE_HW_LASCAR_EL_USB
139extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
140#endif
141#ifdef HAVE_HW_MIC_985XX
142extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
143extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
144#endif
145#ifdef HAVE_HW_NORMA_DMM
146extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
147#endif
148#ifdef HAVE_HW_OLS
149extern SR_PRIV struct sr_dev_driver ols_driver_info;
150#endif
151#ifdef HAVE_HW_RIGOL_DS
152extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
153#endif
154#ifdef HAVE_HW_SALEAE_LOGIC16
155extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
156#endif
157#ifdef HAVE_HW_TELEINFO
158extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
159#endif
160#ifdef HAVE_HW_TONDAJ_SL_814
161extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
162#endif
163#ifdef HAVE_HW_UNI_T_UT32X
164extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
165#endif
166#ifdef HAVE_HW_VICTOR_DMM
167extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
168#endif
169#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
170extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
171#endif
172#ifdef HAVE_HW_ASIX_SIGMA
173extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
174#endif
175#ifdef HAVE_HW_CHRONOVU_LA8
176extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
177#endif
178#ifdef HAVE_HW_LINK_MSO19
179extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
180#endif
181#ifdef HAVE_HW_ALSA
182extern SR_PRIV struct sr_dev_driver alsa_driver_info;
183#endif
184#ifdef HAVE_HW_FX2LAFW
185extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
186#endif
187#ifdef HAVE_HW_HANTEK_DSO
188extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
189#endif
190#ifdef HAVE_HW_AGILENT_DMM
191extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
192#endif
193#ifdef HAVE_HW_FLUKE_DMM
194extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
195#endif
196#ifdef HAVE_HW_SERIAL_DMM
197extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
198extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
199extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
200extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
201extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
202extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
203extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
204extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
205extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
206extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
207extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
208extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
209extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
210extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
211extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
212extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
213extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
214extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
215extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
216extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
217extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
218extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
219extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
220extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
221#endif
222#ifdef HAVE_HW_UNI_T_DMM
223extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
224extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
225extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
226extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
227extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
228extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
229extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
230extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
231extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
232#endif
233/** @endcond */
234
235static struct sr_dev_driver *drivers_list[] = {
236#ifdef HAVE_HW_BRYMEN_DMM
237 &brymen_bm857_driver_info,
238#endif
239#ifdef HAVE_HW_CEM_DT_885X
240 &cem_dt_885x_driver_info,
241#endif
242#ifdef HAVE_HW_CENTER_3XX
243 &center_309_driver_info,
244 &voltcraft_k204_driver_info,
245#endif
246#ifdef HAVE_HW_COLEAD_SLM
247 &colead_slm_driver_info,
248#endif
249#ifdef HAVE_HW_DEMO
250 &demo_driver_info,
251#endif
252#ifdef HAVE_HW_GMC_MH_1X_2X
253 &gmc_mh_1x_2x_rs232_driver_info,
254#endif
255#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
256 &ikalogic_scanalogic2_driver_info,
257#endif
258#ifdef HAVE_HW_IKALOGIC_SCANAPLUS
259 &ikalogic_scanaplus_driver_info,
260#endif
261#ifdef HAVE_HW_KECHENG_KC_330B
262 &kecheng_kc_330b_driver_info,
263#endif
264#ifdef HAVE_HW_LASCAR_EL_USB
265 &lascar_el_usb_driver_info,
266#endif
267#ifdef HAVE_HW_MIC_985XX
268 &mic_98581_driver_info,
269 &mic_98583_driver_info,
270#endif
271#ifdef HAVE_HW_NORMA_DMM
272 &norma_dmm_driver_info,
273#endif
274#ifdef HAVE_HW_OLS
275 &ols_driver_info,
276#endif
277#ifdef HAVE_HW_RIGOL_DS
278 &rigol_ds_driver_info,
279#endif
280#ifdef HAVE_HW_SALEAE_LOGIC16
281 &saleae_logic16_driver_info,
282#endif
283#ifdef HAVE_HW_TELEINFO
284 &teleinfo_driver_info,
285#endif
286#ifdef HAVE_HW_TONDAJ_SL_814
287 &tondaj_sl_814_driver_info,
288#endif
289#ifdef HAVE_HW_UNI_T_UT32X
290 &uni_t_ut32x_driver_info,
291#endif
292#ifdef HAVE_HW_VICTOR_DMM
293 &victor_dmm_driver_info,
294#endif
295#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
296 &zeroplus_logic_cube_driver_info,
297#endif
298#ifdef HAVE_HW_ASIX_SIGMA
299 &asix_sigma_driver_info,
300#endif
301#ifdef HAVE_HW_CHRONOVU_LA8
302 &chronovu_la8_driver_info,
303#endif
304#ifdef HAVE_HW_LINK_MSO19
305 &link_mso19_driver_info,
306#endif
307#ifdef HAVE_HW_ALSA
308 &alsa_driver_info,
309#endif
310#ifdef HAVE_HW_FX2LAFW
311 &fx2lafw_driver_info,
312#endif
313#ifdef HAVE_HW_HANTEK_DSO
314 &hantek_dso_driver_info,
315#endif
316#ifdef HAVE_HW_AGILENT_DMM
317 &agdmm_driver_info,
318#endif
319#ifdef HAVE_HW_FLUKE_DMM
320 &flukedmm_driver_info,
321#endif
322#ifdef HAVE_HW_SERIAL_DMM
323 &digitek_dt4000zc_driver_info,
324 &tekpower_tp4000zc_driver_info,
325 &metex_me31_driver_info,
326 &peaktech_3410_driver_info,
327 &mastech_mas345_driver_info,
328 &va_va18b_driver_info,
329 &metex_m3640d_driver_info,
330 &metex_m4650cr_driver_info,
331 &peaktech_4370_driver_info,
332 &pce_pce_dm32_driver_info,
333 &radioshack_22_168_driver_info,
334 &radioshack_22_805_driver_info,
335 &radioshack_22_812_driver_info,
336 &tecpel_dmm_8061_ser_driver_info,
337 &voltcraft_m3650d_driver_info,
338 &voltcraft_m4650cr_driver_info,
339 &voltcraft_vc820_ser_driver_info,
340 &voltcraft_vc830_ser_driver_info,
341 &voltcraft_vc840_ser_driver_info,
342 &uni_t_ut60a_ser_driver_info,
343 &uni_t_ut60e_ser_driver_info,
344 &uni_t_ut61d_ser_driver_info,
345 &uni_t_ut61e_ser_driver_info,
346 &iso_tech_idm103n_driver_info,
347#endif
348#ifdef HAVE_HW_UNI_T_DMM
349 &tecpel_dmm_8061_driver_info,
350 &uni_t_ut60a_driver_info,
351 &uni_t_ut60e_driver_info,
352 &uni_t_ut61d_driver_info,
353 &uni_t_ut61e_driver_info,
354 &voltcraft_vc820_driver_info,
355 &voltcraft_vc830_driver_info,
356 &voltcraft_vc840_driver_info,
357 &tenma_72_7745_driver_info,
358#endif
359 NULL,
360};
361
362/**
363 * Return the list of supported hardware drivers.
364 *
365 * @return Pointer to the NULL-terminated list of hardware driver pointers.
366 */
367SR_API struct sr_dev_driver **sr_driver_list(void)
368{
369
370 return drivers_list;
371}
372
373/**
374 * Initialize a hardware driver.
375 *
376 * This usually involves memory allocations and variable initializations
377 * within the driver, but _not_ scanning for attached devices.
378 * The API call sr_driver_scan() is used for that.
379 *
380 * @param ctx A libsigrok context object allocated by a previous call to
381 * sr_init(). Must not be NULL.
382 * @param driver The driver to initialize. This must be a pointer to one of
383 * the entries returned by sr_driver_list(). Must not be NULL.
384 *
385 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
386 * SR_ERR_BUG upon internal errors, or another negative error code
387 * upon other errors.
388 */
389SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
390{
391 int ret;
392
393 if (!ctx) {
394 sr_err("Invalid libsigrok context, can't initialize.");
395 return SR_ERR_ARG;
396 }
397
398 if (!driver) {
399 sr_err("Invalid driver, can't initialize.");
400 return SR_ERR_ARG;
401 }
402
403 sr_spew("Initializing driver '%s'.", driver->name);
404 if ((ret = driver->init(ctx)) < 0)
405 sr_err("Failed to initialize the driver: %d.", ret);
406
407 return ret;
408}
409
410/**
411 * Tell a hardware driver to scan for devices.
412 *
413 * In addition to the detection, the devices that are found are also
414 * initialized automatically. On some devices, this involves a firmware upload,
415 * or other such measures.
416 *
417 * The order in which the system is scanned for devices is not specified. The
418 * caller should not assume or rely on any specific order.
419 *
420 * Before calling sr_driver_scan(), the user must have previously initialized
421 * the driver by calling sr_driver_init().
422 *
423 * @param driver The driver that should scan. This must be a pointer to one of
424 * the entries returned by sr_driver_list(). Must not be NULL.
425 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
426 * scanner. Can be NULL/empty.
427 *
428 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
429 * found (or errors were encountered). This list must be freed by the
430 * caller using g_slist_free(), but without freeing the data pointed
431 * to in the list.
432 */
433SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
434{
435 GSList *l;
436
437 if (!driver) {
438 sr_err("Invalid driver, can't scan for devices.");
439 return NULL;
440 }
441
442 if (!driver->priv) {
443 sr_err("Driver not initialized, can't scan for devices.");
444 return NULL;
445 }
446
447 l = driver->scan(options);
448
449 sr_spew("Scan of '%s' found %d devices.", driver->name,
450 g_slist_length(l));
451
452 return l;
453}
454
455/** @private */
456SR_PRIV void sr_hw_cleanup_all(void)
457{
458 int i;
459 struct sr_dev_driver **drivers;
460
461 drivers = sr_driver_list();
462 for (i = 0; drivers[i]; i++) {
463 if (drivers[i]->cleanup)
464 drivers[i]->cleanup();
465 }
466}
467
468/** A floating reference can be passed in for data.
469 * @private */
470SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
471{
472 struct sr_config *src;
473
474 if (!(src = g_try_malloc(sizeof(struct sr_config))))
475 return NULL;
476 src->key = key;
477 src->data = g_variant_ref_sink(data);
478
479 return src;
480}
481
482/** @private */
483SR_PRIV void sr_config_free(struct sr_config *src)
484{
485
486 if (!src || !src->data) {
487 sr_err("%s: invalid data!", __func__);
488 return;
489 }
490
491 g_variant_unref(src->data);
492 g_free(src);
493
494}
495
496/**
497 * Returns information about the given driver or device instance.
498 *
499 * @param driver The sr_dev_driver struct to query.
500 * @param sdi (optional) If the key is specific to a device, this must
501 * contain a pointer to the struct sr_dev_inst to be checked.
502 * Otherwise it must be NULL.
503 * @param probe_group The probe group on the device for which to list the
504 * values, or NULL.
505 * @param key The configuration key (SR_CONF_*).
506 * @param data Pointer to a GVariant where the value will be stored. Must
507 * not be NULL. The caller is given ownership of the GVariant
508 * and must thus decrease the refcount after use. However if
509 * this function returns an error code, the field should be
510 * considered unused, and should not be unreferenced.
511 *
512 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
513 * may be returned by the driver indicating it doesn't know that key,
514 * but this is not to be flagged as an error by the caller; merely
515 * as an indication that it's not applicable.
516 */
517SR_API int sr_config_get(const struct sr_dev_driver *driver,
518 const struct sr_dev_inst *sdi,
519 const struct sr_probe_group *probe_group,
520 int key, GVariant **data)
521{
522 int ret;
523
524 if (!driver || !data)
525 return SR_ERR;
526
527 if (!driver->config_get)
528 return SR_ERR_ARG;
529
530 if ((ret = driver->config_get(key, data, sdi, probe_group)) == SR_OK) {
531 /* Got a floating reference from the driver. Sink it here,
532 * caller will need to unref when done with it. */
533 g_variant_ref_sink(*data);
534 }
535
536 return ret;
537}
538
539/**
540 * Set a configuration key in a device instance.
541 *
542 * @param sdi The device instance.
543 * @param probe_group The probe group on the device for which to list the
544 * values, or NULL.
545 * @param key The configuration key (SR_CONF_*).
546 * @param data The new value for the key, as a GVariant with GVariantType
547 * appropriate to that key. A floating reference can be passed
548 * in; its refcount will be sunk and unreferenced after use.
549 *
550 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
551 * may be returned by the driver indicating it doesn't know that key,
552 * but this is not to be flagged as an error by the caller; merely
553 * as an indication that it's not applicable.
554 */
555SR_API int sr_config_set(const struct sr_dev_inst *sdi,
556 const struct sr_probe_group *probe_group,
557 int key, GVariant *data)
558{
559 int ret;
560
561 g_variant_ref_sink(data);
562
563 if (!sdi || !sdi->driver || !data)
564 ret = SR_ERR;
565 else if (!sdi->driver->config_set)
566 ret = SR_ERR_ARG;
567 else
568 ret = sdi->driver->config_set(key, data, sdi, probe_group);
569
570 g_variant_unref(data);
571
572 return ret;
573}
574
575/**
576 * List all possible values for a configuration key.
577 *
578 * @param driver The sr_dev_driver struct to query.
579 * @param sdi (optional) If the key is specific to a device, this must
580 * contain a pointer to the struct sr_dev_inst to be checked.
581 * @param probe_group The probe group on the device for which to list the
582 * values, or NULL.
583 * @param key The configuration key (SR_CONF_*).
584 * @param data A pointer to a GVariant where the list will be stored. The
585 * caller is given ownership of the GVariant and must thus
586 * unref the GVariant after use. However if this function
587 * returns an error code, the field should be considered
588 * unused, and should not be unreferenced.
589 *
590 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
591 * may be returned by the driver indicating it doesn't know that key,
592 * but this is not to be flagged as an error by the caller; merely
593 * as an indication that it's not applicable.
594 */
595SR_API int sr_config_list(const struct sr_dev_driver *driver,
596 const struct sr_dev_inst *sdi,
597 const struct sr_probe_group *probe_group,
598 int key, GVariant **data)
599{
600 int ret;
601
602 if (!driver || !data)
603 ret = SR_ERR;
604 else if (!driver->config_list)
605 ret = SR_ERR_ARG;
606 else if ((ret = driver->config_list(key, data, sdi, probe_group)) == SR_OK)
607 g_variant_ref_sink(*data);
608
609 return ret;
610}
611
612/**
613 * Get information about a configuration key.
614 *
615 * @param key The configuration key.
616 *
617 * @return A pointer to a struct sr_config_info, or NULL if the key
618 * was not found.
619 */
620SR_API const struct sr_config_info *sr_config_info_get(int key)
621{
622 int i;
623
624 for (i = 0; sr_config_info_data[i].key; i++) {
625 if (sr_config_info_data[i].key == key)
626 return &sr_config_info_data[i];
627 }
628
629 return NULL;
630}
631
632/**
633 * Get information about an configuration key, by name.
634 *
635 * @param optname The configuration key.
636 *
637 * @return A pointer to a struct sr_config_info, or NULL if the key
638 * was not found.
639 */
640SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
641{
642 int i;
643
644 for (i = 0; sr_config_info_data[i].key; i++) {
645 if (!strcmp(sr_config_info_data[i].id, optname))
646 return &sr_config_info_data[i];
647 }
648
649 return NULL;
650}
651
652/* Unnecessary level of indirection follows. */
653
654/** @private */
655SR_PRIV int sr_source_remove(int fd)
656{
657 return sr_session_source_remove(fd);
658}
659
660/** @private */
661SR_PRIV int sr_source_add(int fd, int events, int timeout,
662 sr_receive_data_callback_t cb, void *cb_data)
663{
664 return sr_session_source_add(fd, events, timeout, cb, cb_data);
665}
666
667/** @} */
Hardware access and backend lib