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