]> 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
zeroplus-logic-cube: Publish SR_CONF_MAX_UNCOMPRESSED_SAMPLES.
[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 {SR_CONF_MAX_UNCOMPRESSED_SAMPLES, SR_T_UINT64, "max_uncompressed_samples",
104 "Maximum number of uncompressed samples", NULL},
105 {0, 0, NULL, NULL, NULL},
106};
107
108/** @cond PRIVATE */
109#ifdef HAVE_HW_APPA_55II
110extern SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
111#endif
112#ifdef HAVE_HW_BRYMEN_DMM
113extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
114#endif
115#ifdef HAVE_HW_CEM_DT_885X
116extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
117#endif
118#ifdef HAVE_HW_CENTER_3XX
119extern SR_PRIV struct sr_dev_driver center_309_driver_info;
120extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
121#endif
122#ifdef HAVE_HW_COLEAD_SLM
123extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
124#endif
125#ifdef HAVE_HW_DEMO
126extern SR_PRIV struct sr_dev_driver demo_driver_info;
127#endif
128#ifdef HAVE_HW_GMC_MH_1X_2X
129extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
130#endif
131#ifdef HAVE_HW_HAMEG_HMO
132extern SR_PRIV struct sr_dev_driver hameg_hmo_driver_info;
133#endif
134#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
135extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
136#endif
137#ifdef HAVE_HW_IKALOGIC_SCANAPLUS
138extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
139#endif
140#ifdef HAVE_HW_KECHENG_KC_330B
141extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
142#endif
143#ifdef HAVE_HW_LASCAR_EL_USB
144extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
145#endif
146#ifdef HAVE_HW_MIC_985XX
147extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
148extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
149#endif
150#ifdef HAVE_HW_NORMA_DMM
151extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
152#endif
153#ifdef HAVE_HW_OLS
154extern SR_PRIV struct sr_dev_driver ols_driver_info;
155#endif
156#ifdef HAVE_HW_RIGOL_DS
157extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
158#endif
159#ifdef HAVE_HW_SALEAE_LOGIC16
160extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
161#endif
162#ifdef HAVE_HW_TELEINFO
163extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
164#endif
165#ifdef HAVE_HW_TONDAJ_SL_814
166extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
167#endif
168#ifdef HAVE_HW_UNI_T_UT32X
169extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
170#endif
171#ifdef HAVE_HW_VICTOR_DMM
172extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
173#endif
174#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
175extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
176#endif
177#ifdef HAVE_HW_ASIX_SIGMA
178extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
179#endif
180#ifdef HAVE_HW_CHRONOVU_LA8
181extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
182#endif
183#ifdef HAVE_HW_LINK_MSO19
184extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
185#endif
186#ifdef HAVE_HW_ALSA
187extern SR_PRIV struct sr_dev_driver alsa_driver_info;
188#endif
189#ifdef HAVE_HW_FX2LAFW
190extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
191#endif
192#ifdef HAVE_HW_HANTEK_DSO
193extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
194#endif
195#ifdef HAVE_HW_AGILENT_DMM
196extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
197#endif
198#ifdef HAVE_HW_FLUKE_DMM
199extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
200#endif
201#ifdef HAVE_HW_SERIAL_DMM
202extern SR_PRIV struct sr_dev_driver bbcgm_m2110_driver_info;
203extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
204extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
205extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
206extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
207extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
208extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
209extern SR_PRIV struct sr_dev_driver va_va40b_driver_info;
210extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
211extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
212extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
213extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
214extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
215extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
216extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
217extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
218extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
219extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
220extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
221extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
222extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
223extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
224extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
225extern SR_PRIV struct sr_dev_driver uni_t_ut60g_ser_driver_info;
226extern SR_PRIV struct sr_dev_driver uni_t_ut61b_ser_driver_info;
227extern SR_PRIV struct sr_dev_driver uni_t_ut61c_ser_driver_info;
228extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
229extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
230extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
231extern SR_PRIV struct sr_dev_driver tenma_72_7745_ser_driver_info;
232extern SR_PRIV struct sr_dev_driver tenma_72_7750_ser_driver_info;
233#endif
234#ifdef HAVE_HW_UNI_T_DMM
235extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
236extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
237extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
238extern SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
239extern SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
240extern SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
241extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
242extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
243extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
244extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
245extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
246extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
247extern SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
248#endif
249/** @endcond */
250
251static struct sr_dev_driver *drivers_list[] = {
252#ifdef HAVE_HW_APPA_55II
253 &appa_55ii_driver_info,
254#endif
255#ifdef HAVE_HW_BRYMEN_DMM
256 &brymen_bm857_driver_info,
257#endif
258#ifdef HAVE_HW_CEM_DT_885X
259 &cem_dt_885x_driver_info,
260#endif
261#ifdef HAVE_HW_CENTER_3XX
262 &center_309_driver_info,
263 &voltcraft_k204_driver_info,
264#endif
265#ifdef HAVE_HW_COLEAD_SLM
266 &colead_slm_driver_info,
267#endif
268#ifdef HAVE_HW_DEMO
269 &demo_driver_info,
270#endif
271#ifdef HAVE_HW_GMC_MH_1X_2X
272 &gmc_mh_1x_2x_rs232_driver_info,
273#endif
274#ifdef HAVE_HW_HAMEG_HMO
275 &hameg_hmo_driver_info,
276#endif
277#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
278 &ikalogic_scanalogic2_driver_info,
279#endif
280#ifdef HAVE_HW_IKALOGIC_SCANAPLUS
281 &ikalogic_scanaplus_driver_info,
282#endif
283#ifdef HAVE_HW_KECHENG_KC_330B
284 &kecheng_kc_330b_driver_info,
285#endif
286#ifdef HAVE_HW_LASCAR_EL_USB
287 &lascar_el_usb_driver_info,
288#endif
289#ifdef HAVE_HW_MIC_985XX
290 &mic_98581_driver_info,
291 &mic_98583_driver_info,
292#endif
293#ifdef HAVE_HW_NORMA_DMM
294 &norma_dmm_driver_info,
295#endif
296#ifdef HAVE_HW_OLS
297 &ols_driver_info,
298#endif
299#ifdef HAVE_HW_RIGOL_DS
300 &rigol_ds_driver_info,
301#endif
302#ifdef HAVE_HW_SALEAE_LOGIC16
303 &saleae_logic16_driver_info,
304#endif
305#ifdef HAVE_HW_TELEINFO
306 &teleinfo_driver_info,
307#endif
308#ifdef HAVE_HW_TONDAJ_SL_814
309 &tondaj_sl_814_driver_info,
310#endif
311#ifdef HAVE_HW_UNI_T_UT32X
312 &uni_t_ut32x_driver_info,
313#endif
314#ifdef HAVE_HW_VICTOR_DMM
315 &victor_dmm_driver_info,
316#endif
317#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
318 &zeroplus_logic_cube_driver_info,
319#endif
320#ifdef HAVE_HW_ASIX_SIGMA
321 &asix_sigma_driver_info,
322#endif
323#ifdef HAVE_HW_CHRONOVU_LA8
324 &chronovu_la8_driver_info,
325#endif
326#ifdef HAVE_HW_LINK_MSO19
327 &link_mso19_driver_info,
328#endif
329#ifdef HAVE_HW_ALSA
330 &alsa_driver_info,
331#endif
332#ifdef HAVE_HW_FX2LAFW
333 &fx2lafw_driver_info,
334#endif
335#ifdef HAVE_HW_HANTEK_DSO
336 &hantek_dso_driver_info,
337#endif
338#ifdef HAVE_HW_AGILENT_DMM
339 &agdmm_driver_info,
340#endif
341#ifdef HAVE_HW_FLUKE_DMM
342 &flukedmm_driver_info,
343#endif
344#ifdef HAVE_HW_SERIAL_DMM
345 &bbcgm_m2110_driver_info,
346 &digitek_dt4000zc_driver_info,
347 &tekpower_tp4000zc_driver_info,
348 &metex_me31_driver_info,
349 &peaktech_3410_driver_info,
350 &mastech_mas345_driver_info,
351 &va_va18b_driver_info,
352 &va_va40b_driver_info,
353 &metex_m3640d_driver_info,
354 &metex_m4650cr_driver_info,
355 &peaktech_4370_driver_info,
356 &pce_pce_dm32_driver_info,
357 &radioshack_22_168_driver_info,
358 &radioshack_22_805_driver_info,
359 &radioshack_22_812_driver_info,
360 &tecpel_dmm_8061_ser_driver_info,
361 &voltcraft_m3650d_driver_info,
362 &voltcraft_m4650cr_driver_info,
363 &voltcraft_vc820_ser_driver_info,
364 &voltcraft_vc830_ser_driver_info,
365 &voltcraft_vc840_ser_driver_info,
366 &uni_t_ut60a_ser_driver_info,
367 &uni_t_ut60e_ser_driver_info,
368 &uni_t_ut60g_ser_driver_info,
369 &uni_t_ut61b_ser_driver_info,
370 &uni_t_ut61c_ser_driver_info,
371 &uni_t_ut61d_ser_driver_info,
372 &uni_t_ut61e_ser_driver_info,
373 &iso_tech_idm103n_driver_info,
374 &tenma_72_7745_ser_driver_info,
375 &tenma_72_7750_ser_driver_info,
376#endif
377#ifdef HAVE_HW_UNI_T_DMM
378 &tecpel_dmm_8061_driver_info,
379 &uni_t_ut60a_driver_info,
380 &uni_t_ut60e_driver_info,
381 &uni_t_ut60g_driver_info,
382 &uni_t_ut61b_driver_info,
383 &uni_t_ut61c_driver_info,
384 &uni_t_ut61d_driver_info,
385 &uni_t_ut61e_driver_info,
386 &voltcraft_vc820_driver_info,
387 &voltcraft_vc830_driver_info,
388 &voltcraft_vc840_driver_info,
389 &tenma_72_7745_driver_info,
390 &tenma_72_7750_driver_info,
391#endif
392 NULL,
393};
394
395/**
396 * Return the list of supported hardware drivers.
397 *
398 * @return Pointer to the NULL-terminated list of hardware driver pointers.
399 */
400SR_API struct sr_dev_driver **sr_driver_list(void)
401{
402
403 return drivers_list;
404}
405
406/**
407 * Initialize a hardware driver.
408 *
409 * This usually involves memory allocations and variable initializations
410 * within the driver, but _not_ scanning for attached devices.
411 * The API call sr_driver_scan() is used for that.
412 *
413 * @param ctx A libsigrok context object allocated by a previous call to
414 * sr_init(). Must not be NULL.
415 * @param driver The driver to initialize. This must be a pointer to one of
416 * the entries returned by sr_driver_list(). Must not be NULL.
417 *
418 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
419 * SR_ERR_BUG upon internal errors, or another negative error code
420 * upon other errors.
421 */
422SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
423{
424 int ret;
425
426 if (!ctx) {
427 sr_err("Invalid libsigrok context, can't initialize.");
428 return SR_ERR_ARG;
429 }
430
431 if (!driver) {
432 sr_err("Invalid driver, can't initialize.");
433 return SR_ERR_ARG;
434 }
435
436 sr_spew("Initializing driver '%s'.", driver->name);
437 if ((ret = driver->init(ctx)) < 0)
438 sr_err("Failed to initialize the driver: %d.", ret);
439
440 return ret;
441}
442
443/**
444 * Tell a hardware driver to scan for devices.
445 *
446 * In addition to the detection, the devices that are found are also
447 * initialized automatically. On some devices, this involves a firmware upload,
448 * or other such measures.
449 *
450 * The order in which the system is scanned for devices is not specified. The
451 * caller should not assume or rely on any specific order.
452 *
453 * Before calling sr_driver_scan(), the user must have previously initialized
454 * the driver by calling sr_driver_init().
455 *
456 * @param driver The driver that should scan. This must be a pointer to one of
457 * the entries returned by sr_driver_list(). Must not be NULL.
458 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
459 * scanner. Can be NULL/empty.
460 *
461 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
462 * found (or errors were encountered). This list must be freed by the
463 * caller using g_slist_free(), but without freeing the data pointed
464 * to in the list.
465 */
466SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
467{
468 GSList *l;
469
470 if (!driver) {
471 sr_err("Invalid driver, can't scan for devices.");
472 return NULL;
473 }
474
475 if (!driver->priv) {
476 sr_err("Driver not initialized, can't scan for devices.");
477 return NULL;
478 }
479
480 l = driver->scan(options);
481
482 sr_spew("Scan of '%s' found %d devices.", driver->name,
483 g_slist_length(l));
484
485 return l;
486}
487
488/** @private */
489SR_PRIV void sr_hw_cleanup_all(void)
490{
491 int i;
492 struct sr_dev_driver **drivers;
493
494 drivers = sr_driver_list();
495 for (i = 0; drivers[i]; i++) {
496 if (drivers[i]->cleanup)
497 drivers[i]->cleanup();
498 }
499}
500
501/** A floating reference can be passed in for data.
502 * @private */
503SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
504{
505 struct sr_config *src;
506
507 if (!(src = g_try_malloc(sizeof(struct sr_config))))
508 return NULL;
509 src->key = key;
510 src->data = g_variant_ref_sink(data);
511
512 return src;
513}
514
515/** @private */
516SR_PRIV void sr_config_free(struct sr_config *src)
517{
518
519 if (!src || !src->data) {
520 sr_err("%s: invalid data!", __func__);
521 return;
522 }
523
524 g_variant_unref(src->data);
525 g_free(src);
526
527}
528
529/**
530 * Returns information about the given driver or device instance.
531 *
532 * @param driver The sr_dev_driver struct to query.
533 * @param sdi (optional) If the key is specific to a device, this must
534 * contain a pointer to the struct sr_dev_inst to be checked.
535 * Otherwise it must be NULL.
536 * @param probe_group The probe group on the device for which to list the
537 * values, or NULL.
538 * @param key The configuration key (SR_CONF_*).
539 * @param data Pointer to a GVariant where the value will be stored. Must
540 * not be NULL. The caller is given ownership of the GVariant
541 * and must thus decrease the refcount after use. However if
542 * this function returns an error code, the field should be
543 * considered unused, and should not be unreferenced.
544 *
545 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
546 * may be returned by the driver indicating it doesn't know that key,
547 * but this is not to be flagged as an error by the caller; merely
548 * as an indication that it's not applicable.
549 */
550SR_API int sr_config_get(const struct sr_dev_driver *driver,
551 const struct sr_dev_inst *sdi,
552 const struct sr_probe_group *probe_group,
553 int key, GVariant **data)
554{
555 int ret;
556
557 if (!driver || !data)
558 return SR_ERR;
559
560 if (!driver->config_get)
561 return SR_ERR_ARG;
562
563 if ((ret = driver->config_get(key, data, sdi, probe_group)) == SR_OK) {
564 /* Got a floating reference from the driver. Sink it here,
565 * caller will need to unref when done with it. */
566 g_variant_ref_sink(*data);
567 }
568
569 return ret;
570}
571
572/**
573 * Set a configuration key in a device instance.
574 *
575 * @param sdi The device instance.
576 * @param probe_group The probe group on the device for which to list the
577 * values, or NULL.
578 * @param key The configuration key (SR_CONF_*).
579 * @param data The new value for the key, as a GVariant with GVariantType
580 * appropriate to that key. A floating reference can be passed
581 * in; its refcount will be sunk and unreferenced after use.
582 *
583 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
584 * may be returned by the driver indicating it doesn't know that key,
585 * but this is not to be flagged as an error by the caller; merely
586 * as an indication that it's not applicable.
587 */
588SR_API int sr_config_set(const struct sr_dev_inst *sdi,
589 const struct sr_probe_group *probe_group,
590 int key, GVariant *data)
591{
592 int ret;
593
594 g_variant_ref_sink(data);
595
596 if (!sdi || !sdi->driver || !data)
597 ret = SR_ERR;
598 else if (!sdi->driver->config_set)
599 ret = SR_ERR_ARG;
600 else
601 ret = sdi->driver->config_set(key, data, sdi, probe_group);
602
603 g_variant_unref(data);
604
605 return ret;
606}
607
608/**
609 * List all possible values for a configuration key.
610 *
611 * @param driver The sr_dev_driver struct to query.
612 * @param sdi (optional) If the key is specific to a device, this must
613 * contain a pointer to the struct sr_dev_inst to be checked.
614 * @param probe_group The probe group on the device for which to list the
615 * values, or NULL.
616 * @param key The configuration key (SR_CONF_*).
617 * @param data A pointer to a GVariant where the list will be stored. The
618 * caller is given ownership of the GVariant and must thus
619 * unref the GVariant after use. However if this function
620 * returns an error code, the field should be considered
621 * unused, and should not be unreferenced.
622 *
623 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
624 * may be returned by the driver indicating it doesn't know that key,
625 * but this is not to be flagged as an error by the caller; merely
626 * as an indication that it's not applicable.
627 */
628SR_API int sr_config_list(const struct sr_dev_driver *driver,
629 const struct sr_dev_inst *sdi,
630 const struct sr_probe_group *probe_group,
631 int key, GVariant **data)
632{
633 int ret;
634
635 if (!driver || !data)
636 ret = SR_ERR;
637 else if (!driver->config_list)
638 ret = SR_ERR_ARG;
639 else if ((ret = driver->config_list(key, data, sdi, probe_group)) == SR_OK)
640 g_variant_ref_sink(*data);
641
642 return ret;
643}
644
645/**
646 * Get information about a configuration key.
647 *
648 * @param key The configuration key.
649 *
650 * @return A pointer to a struct sr_config_info, or NULL if the key
651 * was not found.
652 */
653SR_API const struct sr_config_info *sr_config_info_get(int key)
654{
655 int i;
656
657 for (i = 0; sr_config_info_data[i].key; i++) {
658 if (sr_config_info_data[i].key == key)
659 return &sr_config_info_data[i];
660 }
661
662 return NULL;
663}
664
665/**
666 * Get information about an configuration key, by name.
667 *
668 * @param optname The configuration key.
669 *
670 * @return A pointer to a struct sr_config_info, or NULL if the key
671 * was not found.
672 */
673SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
674{
675 int i;
676
677 for (i = 0; sr_config_info_data[i].key; i++) {
678 if (!strcmp(sr_config_info_data[i].id, optname))
679 return &sr_config_info_data[i];
680 }
681
682 return NULL;
683}
684
685/* Unnecessary level of indirection follows. */
686
687/** @private */
688SR_PRIV int sr_source_remove(int fd)
689{
690 return sr_session_source_remove(fd);
691}
692
693/** @private */
694SR_PRIV int sr_source_add(int fd, int events, int timeout,
695 sr_receive_data_callback_t cb, void *cb_data)
696{
697 return sr_session_source_add(fd, events, timeout, cb, cb_data);
698}
699
700/** @} */
Hardware access and backend lib