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