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