]> 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
detect version 1.x of libftdi library
[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/** @cond PRIVATE */
31#define LOG_PREFIX "hwdriver"
32/** @endcond */
33
34/**
35 * @file
36 *
37 * Hardware driver handling in libsigrok.
38 */
39
40/**
41 * @defgroup grp_driver Hardware drivers
42 *
43 * Hardware driver handling in libsigrok.
44 *
45 * @{
46 */
47
48static struct sr_config_info sr_config_info_data[] = {
49 {SR_CONF_CONN, SR_T_STRING, "conn",
50 "Connection", NULL},
51 {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
52 "Serial communication", NULL},
53 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
54 "Sample rate", NULL},
55 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
56 "Pre-trigger capture ratio", NULL},
57 {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
58 "Pattern", NULL},
59 {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
60 "Trigger matches", NULL},
61 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
62 "External clock mode", NULL},
63 {SR_CONF_SWAP, SR_T_BOOL, "swap",
64 "Swap channel order", NULL},
65 {SR_CONF_RLE, SR_T_BOOL, "rle",
66 "Run Length Encoding", NULL},
67 {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
68 "Trigger slope", NULL},
69 {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
70 "Trigger source", NULL},
71 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
72 "Horizontal trigger position", NULL},
73 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
74 "Buffer size", NULL},
75 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
76 "Time base", NULL},
77 {SR_CONF_FILTER, SR_T_STRING, "filter",
78 "Filter targets", NULL},
79 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
80 "Volts/div", NULL},
81 {SR_CONF_COUPLING, SR_T_STRING, "coupling",
82 "Coupling", NULL},
83 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
84 "Datalog", NULL},
85 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
86 "Sound pressure level frequency weighting", NULL},
87 {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
88 "Sound pressure level time weighting", NULL},
89 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
90 "Hold max", NULL},
91 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
92 "Hold min", NULL},
93 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
94 "Sound pressure level measurement range", NULL},
95 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
96 "Voltage threshold", NULL },
97 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
98 "Power off", NULL},
99 {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
100 "Data source", NULL},
101 {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
102 "Number of logic channels", NULL},
103 {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
104 "Number of analog channels", 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_STRING, "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 {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
122 "Sample limit", NULL},
123 {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
124 "Clock edge", NULL},
125 {0, 0, NULL, NULL, NULL},
126};
127
128/** @cond PRIVATE */
129#ifdef HAVE_HW_APPA_55II
130extern SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
131#endif
132#ifdef HAVE_HW_ATTEN_PPS3XXX
133extern SR_PRIV struct sr_dev_driver atten_pps3203_driver_info;
134#endif
135#ifdef HAVE_HW_BRYMEN_BM86X
136extern SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info;
137#endif
138#ifdef HAVE_HW_BRYMEN_DMM
139extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
140#endif
141#ifdef HAVE_HW_CEM_DT_885X
142extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
143#endif
144#ifdef HAVE_HW_CENTER_3XX
145extern SR_PRIV struct sr_dev_driver center_309_driver_info;
146extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
147#endif
148#ifdef HAVE_HW_COLEAD_SLM
149extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
150#endif
151#ifdef HAVE_HW_CONRAD_DIGI_35_CPU
152extern SR_PRIV struct sr_dev_driver conrad_digi_35_cpu_driver_info;
153#endif
154#ifdef HAVE_HW_DEMO
155extern SR_PRIV struct sr_dev_driver demo_driver_info;
156#endif
157#ifdef HAVE_HW_GMC_MH_1X_2X
158extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
159extern SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info;
160#endif
161#ifdef HAVE_HW_HAMEG_HMO
162extern SR_PRIV struct sr_dev_driver hameg_hmo_driver_info;
163#endif
164#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
165extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
166#endif
167#ifdef HAVE_HW_IKALOGIC_SCANAPLUS
168extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
169#endif
170#ifdef HAVE_HW_KECHENG_KC_330B
171extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
172#endif
173#ifdef HAVE_HW_LASCAR_EL_USB
174extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
175#endif
176#ifdef HAVE_HW_MIC_985XX
177extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
178extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
179#endif
180#ifdef HAVE_HW_MOTECH_LPS_30X
181extern SR_PRIV struct sr_dev_driver motech_lps_301_driver_info;
182#endif
183#ifdef HAVE_HW_NORMA_DMM
184extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
185extern SR_PRIV struct sr_dev_driver siemens_b102x_driver_info;
186#endif
187#ifdef HAVE_HW_OLS
188extern SR_PRIV struct sr_dev_driver ols_driver_info;
189#endif
190#ifdef HAVE_HW_RIGOL_DS
191extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
192#endif
193#ifdef HAVE_HW_SALEAE_LOGIC16
194extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
195#endif
196#ifdef HAVE_HW_SYSCLK_LWLA
197extern SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
198#endif
199#ifdef HAVE_HW_TELEINFO
200extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
201#endif
202#ifdef HAVE_HW_TONDAJ_SL_814
203extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
204#endif
205#ifdef HAVE_HW_UNI_T_UT32X
206extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
207#endif
208#ifdef HAVE_HW_VICTOR_DMM
209extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
210#endif
211#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
212extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
213#endif
214#ifdef HAVE_HW_ASIX_SIGMA
215extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
216#endif
217#ifdef HAVE_HW_CHRONOVU_LA
218extern SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
219#endif
220#ifdef HAVE_HW_LINK_MSO19
221extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
222#endif
223#ifdef HAVE_HW_FX2LAFW
224extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
225#endif
226#ifdef HAVE_HW_HANTEK_DSO
227extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
228#endif
229#ifdef HAVE_HW_AGILENT_DMM
230extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
231#endif
232#ifdef HAVE_HW_FLUKE_DMM
233extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
234#endif
235#ifdef HAVE_HW_SERIAL_DMM
236extern SR_PRIV struct sr_dev_driver bbcgm_m2110_driver_info;
237extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
238extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
239extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
240extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
241extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
242extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
243extern SR_PRIV struct sr_dev_driver va_va40b_driver_info;
244extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
245extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
246extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
247extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
248extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
249extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
250extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
251extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
252extern SR_PRIV struct sr_dev_driver voltcraft_m3650cr_driver_info;
253extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
254extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
255extern SR_PRIV struct sr_dev_driver voltcraft_me42_driver_info;
256extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
257extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
258extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
259extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
260extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
261extern SR_PRIV struct sr_dev_driver uni_t_ut60g_ser_driver_info;
262extern SR_PRIV struct sr_dev_driver uni_t_ut61b_ser_driver_info;
263extern SR_PRIV struct sr_dev_driver uni_t_ut61c_ser_driver_info;
264extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
265extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
266extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
267extern SR_PRIV struct sr_dev_driver tenma_72_7745_ser_driver_info;
268extern SR_PRIV struct sr_dev_driver tenma_72_7750_ser_driver_info;
269#endif
270#ifdef HAVE_HW_UNI_T_DMM
271extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
272extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
273extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
274extern SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
275extern SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
276extern SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
277extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
278extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
279extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
280extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
281extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
282extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
283extern SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
284#endif
285/** @endcond */
286
287static struct sr_dev_driver *drivers_list[] = {
288#ifdef HAVE_HW_APPA_55II
289 &appa_55ii_driver_info,
290#endif
291#ifdef HAVE_HW_ATTEN_PPS3XXX
292 &atten_pps3203_driver_info,
293#endif
294#ifdef HAVE_HW_BRYMEN_BM86X
295 &brymen_bm86x_driver_info,
296#endif
297#ifdef HAVE_HW_BRYMEN_DMM
298 &brymen_bm857_driver_info,
299#endif
300#ifdef HAVE_HW_CEM_DT_885X
301 &cem_dt_885x_driver_info,
302#endif
303#ifdef HAVE_HW_CENTER_3XX
304 &center_309_driver_info,
305 &voltcraft_k204_driver_info,
306#endif
307#ifdef HAVE_HW_COLEAD_SLM
308 &colead_slm_driver_info,
309#endif
310#ifdef HAVE_HW_CONRAD_DIGI_35_CPU
311 &conrad_digi_35_cpu_driver_info,
312#endif
313#ifdef HAVE_HW_DEMO
314 &demo_driver_info,
315#endif
316#ifdef HAVE_HW_GMC_MH_1X_2X
317 &gmc_mh_1x_2x_rs232_driver_info,
318 &gmc_mh_2x_bd232_driver_info,
319#endif
320#ifdef HAVE_HW_HAMEG_HMO
321 &hameg_hmo_driver_info,
322#endif
323#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
324 &ikalogic_scanalogic2_driver_info,
325#endif
326#ifdef HAVE_HW_IKALOGIC_SCANAPLUS
327 &ikalogic_scanaplus_driver_info,
328#endif
329#ifdef HAVE_HW_KECHENG_KC_330B
330 &kecheng_kc_330b_driver_info,
331#endif
332#ifdef HAVE_HW_LASCAR_EL_USB
333 &lascar_el_usb_driver_info,
334#endif
335#ifdef HAVE_HW_MIC_985XX
336 &mic_98581_driver_info,
337 &mic_98583_driver_info,
338#endif
339#ifdef HAVE_HW_MOTECH_LPS_30X
340 &motech_lps_301_driver_info,
341#endif
342#ifdef HAVE_HW_NORMA_DMM
343 &norma_dmm_driver_info,
344 &siemens_b102x_driver_info,
345#endif
346#ifdef HAVE_HW_OLS
347 &ols_driver_info,
348#endif
349#ifdef HAVE_HW_RIGOL_DS
350 &rigol_ds_driver_info,
351#endif
352#ifdef HAVE_HW_SALEAE_LOGIC16
353 &saleae_logic16_driver_info,
354#endif
355#ifdef HAVE_HW_SYSCLK_LWLA
356 &sysclk_lwla_driver_info,
357#endif
358#ifdef HAVE_HW_TELEINFO
359 &teleinfo_driver_info,
360#endif
361#ifdef HAVE_HW_TONDAJ_SL_814
362 &tondaj_sl_814_driver_info,
363#endif
364#ifdef HAVE_HW_UNI_T_UT32X
365 &uni_t_ut32x_driver_info,
366#endif
367#ifdef HAVE_HW_VICTOR_DMM
368 &victor_dmm_driver_info,
369#endif
370#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
371 &zeroplus_logic_cube_driver_info,
372#endif
373#ifdef HAVE_HW_ASIX_SIGMA
374 &asix_sigma_driver_info,
375#endif
376#ifdef HAVE_HW_CHRONOVU_LA
377 &chronovu_la_driver_info,
378#endif
379#ifdef HAVE_HW_LINK_MSO19
380 &link_mso19_driver_info,
381#endif
382#ifdef HAVE_HW_FX2LAFW
383 &fx2lafw_driver_info,
384#endif
385#ifdef HAVE_HW_HANTEK_DSO
386 &hantek_dso_driver_info,
387#endif
388#ifdef HAVE_HW_AGILENT_DMM
389 &agdmm_driver_info,
390#endif
391#ifdef HAVE_HW_FLUKE_DMM
392 &flukedmm_driver_info,
393#endif
394#ifdef HAVE_HW_SERIAL_DMM
395 &bbcgm_m2110_driver_info,
396 &digitek_dt4000zc_driver_info,
397 &tekpower_tp4000zc_driver_info,
398 &metex_me31_driver_info,
399 &peaktech_3410_driver_info,
400 &mastech_mas345_driver_info,
401 &va_va18b_driver_info,
402 &va_va40b_driver_info,
403 &metex_m3640d_driver_info,
404 &metex_m4650cr_driver_info,
405 &peaktech_4370_driver_info,
406 &pce_pce_dm32_driver_info,
407 &radioshack_22_168_driver_info,
408 &radioshack_22_805_driver_info,
409 &radioshack_22_812_driver_info,
410 &tecpel_dmm_8061_ser_driver_info,
411 &voltcraft_m3650cr_driver_info,
412 &voltcraft_m3650d_driver_info,
413 &voltcraft_m4650cr_driver_info,
414 &voltcraft_me42_driver_info,
415 &voltcraft_vc820_ser_driver_info,
416 &voltcraft_vc830_ser_driver_info,
417 &voltcraft_vc840_ser_driver_info,
418 &uni_t_ut60a_ser_driver_info,
419 &uni_t_ut60e_ser_driver_info,
420 &uni_t_ut60g_ser_driver_info,
421 &uni_t_ut61b_ser_driver_info,
422 &uni_t_ut61c_ser_driver_info,
423 &uni_t_ut61d_ser_driver_info,
424 &uni_t_ut61e_ser_driver_info,
425 &iso_tech_idm103n_driver_info,
426 &tenma_72_7745_ser_driver_info,
427 &tenma_72_7750_ser_driver_info,
428#endif
429#ifdef HAVE_HW_UNI_T_DMM
430 &tecpel_dmm_8061_driver_info,
431 &uni_t_ut60a_driver_info,
432 &uni_t_ut60e_driver_info,
433 &uni_t_ut60g_driver_info,
434 &uni_t_ut61b_driver_info,
435 &uni_t_ut61c_driver_info,
436 &uni_t_ut61d_driver_info,
437 &uni_t_ut61e_driver_info,
438 &voltcraft_vc820_driver_info,
439 &voltcraft_vc830_driver_info,
440 &voltcraft_vc840_driver_info,
441 &tenma_72_7745_driver_info,
442 &tenma_72_7750_driver_info,
443#endif
444 NULL,
445};
446
447/**
448 * Return the list of supported hardware drivers.
449 *
450 * @return Pointer to the NULL-terminated list of hardware driver pointers.
451 *
452 * @since 0.1.0
453 */
454SR_API struct sr_dev_driver **sr_driver_list(void)
455{
456
457 return drivers_list;
458}
459
460/**
461 * Initialize a hardware driver.
462 *
463 * This usually involves memory allocations and variable initializations
464 * within the driver, but _not_ scanning for attached devices.
465 * The API call sr_driver_scan() is used for that.
466 *
467 * @param ctx A libsigrok context object allocated by a previous call to
468 * sr_init(). Must not be NULL.
469 * @param driver The driver to initialize. This must be a pointer to one of
470 * the entries returned by sr_driver_list(). Must not be NULL.
471 *
472 * @retval SR_OK Success
473 * @retval SR_ERR_ARG Invalid parameter(s).
474 * @retval SR_ERR_BUG Internal errors.
475 * @retval other Another negative error code upon other errors.
476 *
477 * @since 0.2.0
478 */
479SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
480{
481 int ret;
482
483 if (!ctx) {
484 sr_err("Invalid libsigrok context, can't initialize.");
485 return SR_ERR_ARG;
486 }
487
488 if (!driver) {
489 sr_err("Invalid driver, can't initialize.");
490 return SR_ERR_ARG;
491 }
492
493 sr_spew("Initializing driver '%s'.", driver->name);
494 if ((ret = driver->init(ctx)) < 0)
495 sr_err("Failed to initialize the driver: %d.", ret);
496
497 return ret;
498}
499
500/**
501 * Tell a hardware driver to scan for devices.
502 *
503 * In addition to the detection, the devices that are found are also
504 * initialized automatically. On some devices, this involves a firmware upload,
505 * or other such measures.
506 *
507 * The order in which the system is scanned for devices is not specified. The
508 * caller should not assume or rely on any specific order.
509 *
510 * Before calling sr_driver_scan(), the user must have previously initialized
511 * the driver by calling sr_driver_init().
512 *
513 * @param driver The driver that should scan. This must be a pointer to one of
514 * the entries returned by sr_driver_list(). Must not be NULL.
515 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
516 * scanner. Can be NULL/empty.
517 *
518 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
519 * found (or errors were encountered). This list must be freed by the
520 * caller using g_slist_free(), but without freeing the data pointed
521 * to in the list.
522 *
523 * @since 0.2.0
524 */
525SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
526{
527 GSList *l;
528
529 if (!driver) {
530 sr_err("Invalid driver, can't scan for devices.");
531 return NULL;
532 }
533
534 if (!driver->priv) {
535 sr_err("Driver not initialized, can't scan for devices.");
536 return NULL;
537 }
538
539 l = driver->scan(options);
540
541 sr_spew("Scan of '%s' found %d devices.", driver->name,
542 g_slist_length(l));
543
544 return l;
545}
546
547/** Call driver cleanup function for all drivers.
548 * @private */
549SR_PRIV void sr_hw_cleanup_all(void)
550{
551 int i;
552 struct sr_dev_driver **drivers;
553
554 drivers = sr_driver_list();
555 for (i = 0; drivers[i]; i++) {
556 if (drivers[i]->cleanup)
557 drivers[i]->cleanup();
558 }
559}
560
561/** Allocate struct sr_config.
562 * A floating reference can be passed in for data.
563 * @private
564 */
565SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
566{
567 struct sr_config *src;
568
569 if (!(src = g_try_malloc(sizeof(struct sr_config))))
570 return NULL;
571 src->key = key;
572 src->data = g_variant_ref_sink(data);
573
574 return src;
575}
576
577/** Free struct sr_config.
578 * @private
579 */
580SR_PRIV void sr_config_free(struct sr_config *src)
581{
582
583 if (!src || !src->data) {
584 sr_err("%s: invalid data!", __func__);
585 return;
586 }
587
588 g_variant_unref(src->data);
589 g_free(src);
590
591}
592
593/**
594 * Query value of a configuration key at the given driver or device instance.
595 *
596 * @param[in] driver The sr_dev_driver struct to query.
597 * @param[in] sdi (optional) If the key is specific to a device, this must
598 * contain a pointer to the struct sr_dev_inst to be checked.
599 * Otherwise it must be NULL.
600 * @param[in] cg The channel group on the device for which to list the
601 * values, or NULL.
602 * @param[in] key The configuration key (SR_CONF_*).
603 * @param[in,out] data Pointer to a GVariant where the value will be stored.
604 * Must not be NULL. The caller is given ownership of the GVariant
605 * and must thus decrease the refcount after use. However if
606 * this function returns an error code, the field should be
607 * considered unused, and should not be unreferenced.
608 *
609 * @retval SR_OK Success.
610 * @retval SR_ERR Error.
611 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
612 * interpreted as an error by the caller; merely as an indication
613 * that it's not applicable.
614 *
615 * @since 0.3.0
616 */
617SR_API int sr_config_get(const struct sr_dev_driver *driver,
618 const struct sr_dev_inst *sdi,
619 const struct sr_channel_group *cg,
620 int key, GVariant **data)
621{
622 int ret;
623
624 if (!driver || !data)
625 return SR_ERR;
626
627 if (!driver->config_get)
628 return SR_ERR_ARG;
629
630 if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
631 /* Got a floating reference from the driver. Sink it here,
632 * caller will need to unref when done with it. */
633 g_variant_ref_sink(*data);
634 }
635
636 return ret;
637}
638
639/**
640 * Set value of a configuration key in a device instance.
641 *
642 * @param[in] sdi The device instance.
643 * @param[in] cg The channel group on the device for which to list the
644 * values, or NULL.
645 * @param[in] key The configuration key (SR_CONF_*).
646 * @param data The new value for the key, as a GVariant with GVariantType
647 * appropriate to that key. A floating reference can be passed
648 * in; its refcount will be sunk and unreferenced after use.
649 *
650 * @retval SR_OK Success.
651 * @retval SR_ERR Error.
652 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
653 * interpreted as an error by the caller; merely as an indication
654 * that it's not applicable.
655 *
656 * @since 0.3.0
657 */
658SR_API int sr_config_set(const struct sr_dev_inst *sdi,
659 const struct sr_channel_group *cg,
660 int key, GVariant *data)
661{
662 int ret;
663
664 g_variant_ref_sink(data);
665
666 if (!sdi || !sdi->driver || !data)
667 ret = SR_ERR;
668 else if (!sdi->driver->config_set)
669 ret = SR_ERR_ARG;
670 else
671 ret = sdi->driver->config_set(key, data, sdi, cg);
672
673 g_variant_unref(data);
674
675 return ret;
676}
677
678/**
679 * Apply configuration settings to the device hardware.
680 *
681 * @param sdi The device instance.
682 *
683 * @return SR_OK upon success or SR_ERR in case of error.
684 *
685 * @since 0.3.0
686 */
687SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
688{
689 int ret;
690
691 if (!sdi || !sdi->driver)
692 ret = SR_ERR;
693 else if (!sdi->driver->config_commit)
694 ret = SR_OK;
695 else
696 ret = sdi->driver->config_commit(sdi);
697
698 return ret;
699}
700
701/**
702 * List all possible values for a configuration key.
703 *
704 * @param[in] driver The sr_dev_driver struct to query.
705 * @param[in] sdi (optional) If the key is specific to a device, this must
706 * contain a pointer to the struct sr_dev_inst to be checked.
707 * @param[in] cg The channel group on the device for which to list the
708 * values, or NULL.
709 * @param[in] key The configuration key (SR_CONF_*).
710 * @param[in,out] data A pointer to a GVariant where the list will be stored.
711 * The caller is given ownership of the GVariant and must thus
712 * unref the GVariant after use. However if this function
713 * returns an error code, the field should be considered
714 * unused, and should not be unreferenced.
715 *
716 * @retval SR_OK Success.
717 * @retval SR_ERR Error.
718 * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
719 * interpreted as an error by the caller; merely as an indication
720 * that it's not applicable.
721 *
722 * @since 0.3.0
723 */
724SR_API int sr_config_list(const struct sr_dev_driver *driver,
725 const struct sr_dev_inst *sdi,
726 const struct sr_channel_group *cg,
727 int key, GVariant **data)
728{
729 int ret;
730
731 if (!driver || !data)
732 ret = SR_ERR;
733 else if (!driver->config_list)
734 ret = SR_ERR_ARG;
735 else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
736 g_variant_ref_sink(*data);
737
738 return ret;
739}
740
741/**
742 * Get information about a configuration key, by key.
743 *
744 * @param[in] key The configuration key.
745 *
746 * @return A pointer to a struct sr_config_info, or NULL if the key
747 * was not found.
748 *
749 * @since 0.2.0
750 */
751SR_API const struct sr_config_info *sr_config_info_get(int key)
752{
753 int i;
754
755 for (i = 0; sr_config_info_data[i].key; i++) {
756 if (sr_config_info_data[i].key == key)
757 return &sr_config_info_data[i];
758 }
759
760 return NULL;
761}
762
763/**
764 * Get information about a configuration key, by name.
765 *
766 * @param[in] optname The configuration key.
767 *
768 * @return A pointer to a struct sr_config_info, or NULL if the key
769 * was not found.
770 *
771 * @since 0.2.0
772 */
773SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
774{
775 int i;
776
777 for (i = 0; sr_config_info_data[i].key; i++) {
778 if (!strcmp(sr_config_info_data[i].id, optname))
779 return &sr_config_info_data[i];
780 }
781
782 return NULL;
783}
784
785/* Unnecessary level of indirection follows. */
786
787/** @private
788 * @see sr_session_source_remove()
789 */
790SR_PRIV int sr_source_remove(int fd)
791{
792 return sr_session_source_remove(fd);
793}
794
795/** @private
796 * @see sr_session_source_add()
797 */
798SR_PRIV int sr_source_add(int fd, int events, int timeout,
799 sr_receive_data_callback cb, void *cb_data)
800{
801 return sr_session_source_add(fd, events, timeout, cb, cb_data);
802}
803
804/** @} */
Hardware access and backend lib