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