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