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