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