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