]> sigrok.org Git - libsigrok.git/blame - hwdriver.c
Add config keys for setting the number of analog probes.
[libsigrok.git] / hwdriver.c
CommitLineData
a1bb33af 1/*
50985c20 2 * This file is part of the libsigrok project.
a1bb33af 3 *
13d8e03c 4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
a1bb33af
UH
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>
545f9786 26#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
45c59c8b
BV
27#include "libsigrok.h"
28#include "libsigrok-internal.h"
a1bb33af 29
3544f848 30#define LOG_PREFIX "hwdriver"
bd36d826 31
393fb9cb
UH
32/**
33 * @file
34 *
35 * Hardware driver handling in libsigrok.
36 */
37
7b870c38
UH
38/**
39 * @defgroup grp_driver Hardware drivers
40 *
41 * Hardware driver handling in libsigrok.
42 *
43 * @{
44 */
8bfdc8c4 45
c89c1c9c 46static struct sr_config_info sr_config_info_data[] = {
1953564a 47 {SR_CONF_CONN, SR_T_CHAR, "conn",
083d64f9 48 "Connection", NULL},
1953564a 49 {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
083d64f9 50 "Serial communication", NULL},
1953564a 51 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
083d64f9 52 "Sample rate", NULL},
1953564a 53 {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
083d64f9 54 "Pre-trigger capture ratio", NULL},
1953564a 55 {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
083d64f9 56 "Pattern generator mode", NULL},
8e34ca86
BV
57 {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
58 "Trigger types", NULL},
eb1b610b
MR
59 {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
60 "External clock mode", NULL},
7b0a57fd
MR
61 {SR_CONF_SWAP, SR_T_BOOL, "swap",
62 "Swap channel order", NULL},
1953564a 63 {SR_CONF_RLE, SR_T_BOOL, "rle",
083d64f9 64 "Run Length Encoding", NULL},
1953564a 65 {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
083d64f9 66 "Trigger slope", NULL},
1953564a 67 {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
083d64f9 68 "Trigger source", NULL},
1953564a 69 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
083d64f9 70 "Horizontal trigger position", NULL},
1953564a 71 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
083d64f9 72 "Buffer size", NULL},
1953564a 73 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
083d64f9 74 "Time base", NULL},
1953564a 75 {SR_CONF_FILTER, SR_T_CHAR, "filter",
083d64f9 76 "Filter targets", NULL},
1953564a 77 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
083d64f9 78 "Volts/div", NULL},
1953564a 79 {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
083d64f9 80 "Coupling", NULL},
e6551ea6
BV
81 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
82 "Datalog", NULL},
fd8854c4
BV
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},
9fd6bc20
BV
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},
8417ebad
BV
91 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
92 "Sound pressure level measurement range", NULL},
db11d7d2
MC
93 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
94 "Voltage threshold", NULL },
32de50b7
BV
95 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
96 "Power off", NULL},
6caeef6e
BV
97 {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
98 "Data source", NULL},
bf90d4c6
BV
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},
083d64f9 103 {0, 0, NULL, NULL, NULL},
a1bb33af
UH
104};
105
b4bd7088 106/** @cond PRIVATE */
5e7a8e57
AJ
107#ifdef HAVE_HW_APPA_55II
108extern SR_PRIV struct sr_dev_driver appa_55ii_driver_info;
109#endif
20cbc785 110#ifdef HAVE_HW_BRYMEN_DMM
c5d6f5cc 111extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
20cbc785 112#endif
8fa9368e
BV
113#ifdef HAVE_HW_CEM_DT_885X
114extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
115#endif
4433145f 116#ifdef HAVE_HW_CENTER_3XX
4a8bbed7
UH
117extern SR_PRIV struct sr_dev_driver center_309_driver_info;
118extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
4433145f 119#endif
4d729ddc
BV
120#ifdef HAVE_HW_COLEAD_SLM
121extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
122#endif
9e165e74 123#ifdef HAVE_HW_DEMO
c09f0b57 124extern SR_PRIV struct sr_dev_driver demo_driver_info;
a61b0e6a 125#endif
7b4edcb6
MH
126#ifdef HAVE_HW_GMC_MH_1X_2X
127extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
128#endif
06a3e78a
DJ
129#ifdef HAVE_HW_HAMEG_HMO
130extern SR_PRIV struct sr_dev_driver hameg_hmo_driver_info;
131#endif
16e76bae
MS
132#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
133extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
134#endif
fdf4a1f5
UH
135#ifdef HAVE_HW_IKALOGIC_SCANAPLUS
136extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
e84e0096 137#endif
ed759a08
BV
138#ifdef HAVE_HW_KECHENG_KC_330B
139extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
fdf4a1f5 140#endif
46697e38
BV
141#ifdef HAVE_HW_LASCAR_EL_USB
142extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
143#endif
7ec5b549 144#ifdef HAVE_HW_MIC_985XX
6f3e5335 145extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
0cd8e231 146extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
7ec5b549 147#endif
bfd48770
MH
148#ifdef HAVE_HW_NORMA_DMM
149extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
150#endif
9e165e74 151#ifdef HAVE_HW_OLS
c09f0b57 152extern SR_PRIV struct sr_dev_driver ols_driver_info;
960a75e4 153#endif
3086efdd
ML
154#ifdef HAVE_HW_RIGOL_DS
155extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info;
f4816ac6 156#endif
c463dcf0
MC
157#ifdef HAVE_HW_SALEAE_LOGIC16
158extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
159#endif
8e796cb4
AJ
160#ifdef HAVE_HW_TELEINFO
161extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
162#endif
aa2af324
UH
163#ifdef HAVE_HW_TONDAJ_SL_814
164extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
165#endif
3877dde4
BV
166#ifdef HAVE_HW_UNI_T_UT32X
167extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
168#endif
ac3898d2
BV
169#ifdef HAVE_HW_VICTOR_DMM
170extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
171#endif
9e165e74 172#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
c09f0b57 173extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
960a75e4 174#endif
9e165e74 175#ifdef HAVE_HW_ASIX_SIGMA
c09f0b57 176extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
5b907f9b 177#endif
9e165e74 178#ifdef HAVE_HW_CHRONOVU_LA8
c09f0b57 179extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
f4314d7e 180#endif
9e165e74 181#ifdef HAVE_HW_LINK_MSO19
7ab89f48
UH
182extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
183#endif
0254651d 184#ifdef HAVE_HW_ALSA
c09f0b57 185extern SR_PRIV struct sr_dev_driver alsa_driver_info;
6ed4f044 186#endif
9e165e74 187#ifdef HAVE_HW_FX2LAFW
c09f0b57 188extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
f302a082 189#endif
3b533202 190#ifdef HAVE_HW_HANTEK_DSO
62bb8840 191extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
3b533202 192#endif
e93cdf42
BV
193#ifdef HAVE_HW_AGILENT_DMM
194extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
195#endif
e7edd64f
BV
196#ifdef HAVE_HW_FLUKE_DMM
197extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
198#endif
21a7f269 199#ifdef HAVE_HW_SERIAL_DMM
825da8b2 200extern SR_PRIV struct sr_dev_driver bbcgm_m2110_driver_info;
f086b830 201extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
729b01f9 202extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
ce3777ad 203extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
f0ac4929 204extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
5887c9cc 205extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
6dca2f16 206extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
a53da082 207extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
88f544f2 208extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
a376ffea 209extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
d4bd66a0 210extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
d5ce233f 211extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
3864648b 212extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
21829e67 213extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
b38e08fb 214extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
5f2a4aff 215extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
2b83d7fe 216extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
40830061 217extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
6045b91a 218extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
54d11221 219extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
a7a163a7
FK
220extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
221extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
ae3a59de 222extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
986fde75 223extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
df6b0f99 224extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
7dc55d93 225#endif
79081ec8 226#ifdef HAVE_HW_UNI_T_DMM
b6bad47c 227extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
a7a163a7
FK
228extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
229extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
fdbcb86d 230extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
bbef5e32 231extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
fdbcb86d 232extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
c1345749 233extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
695d0e1e 234extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
5e1f7c89 235extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
79081ec8 236#endif
b4bd7088 237/** @endcond */
6ed4f044 238
c09f0b57 239static struct sr_dev_driver *drivers_list[] = {
5e7a8e57
AJ
240#ifdef HAVE_HW_APPA_55II
241 &appa_55ii_driver_info,
242#endif
20cbc785 243#ifdef HAVE_HW_BRYMEN_DMM
c5d6f5cc 244 &brymen_bm857_driver_info,
20cbc785 245#endif
8fa9368e
BV
246#ifdef HAVE_HW_CEM_DT_885X
247 &cem_dt_885x_driver_info,
248#endif
4433145f 249#ifdef HAVE_HW_CENTER_3XX
4a8bbed7
UH
250 &center_309_driver_info,
251 &voltcraft_k204_driver_info,
4433145f 252#endif
4d729ddc
BV
253#ifdef HAVE_HW_COLEAD_SLM
254 &colead_slm_driver_info,
255#endif
9e165e74 256#ifdef HAVE_HW_DEMO
c09f0b57 257 &demo_driver_info,
a61b0e6a 258#endif
7b4edcb6
MH
259#ifdef HAVE_HW_GMC_MH_1X_2X
260 &gmc_mh_1x_2x_rs232_driver_info,
261#endif
06a3e78a
DJ
262#ifdef HAVE_HW_HAMEG_HMO
263 &hameg_hmo_driver_info,
264#endif
16e76bae
MS
265#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
266 &ikalogic_scanalogic2_driver_info,
267#endif
fdf4a1f5
UH
268#ifdef HAVE_HW_IKALOGIC_SCANAPLUS
269 &ikalogic_scanaplus_driver_info,
e84e0096 270#endif
ed759a08
BV
271#ifdef HAVE_HW_KECHENG_KC_330B
272 &kecheng_kc_330b_driver_info,
fdf4a1f5 273#endif
46697e38
BV
274#ifdef HAVE_HW_LASCAR_EL_USB
275 &lascar_el_usb_driver_info,
276#endif
7ec5b549 277#ifdef HAVE_HW_MIC_985XX
6f3e5335 278 &mic_98581_driver_info,
0cd8e231 279 &mic_98583_driver_info,
7ec5b549 280#endif
bfd48770
MH
281#ifdef HAVE_HW_NORMA_DMM
282 &norma_dmm_driver_info,
283#endif
9e165e74 284#ifdef HAVE_HW_OLS
c09f0b57 285 &ols_driver_info,
960a75e4 286#endif
3086efdd
ML
287#ifdef HAVE_HW_RIGOL_DS
288 &rigol_ds_driver_info,
f4816ac6 289#endif
c463dcf0
MC
290#ifdef HAVE_HW_SALEAE_LOGIC16
291 &saleae_logic16_driver_info,
292#endif
8e796cb4
AJ
293#ifdef HAVE_HW_TELEINFO
294 &teleinfo_driver_info,
295#endif
aa2af324
UH
296#ifdef HAVE_HW_TONDAJ_SL_814
297 &tondaj_sl_814_driver_info,
298#endif
3877dde4
BV
299#ifdef HAVE_HW_UNI_T_UT32X
300 &uni_t_ut32x_driver_info,
301#endif
ac3898d2
BV
302#ifdef HAVE_HW_VICTOR_DMM
303 &victor_dmm_driver_info,
304#endif
9e165e74 305#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
c09f0b57 306 &zeroplus_logic_cube_driver_info,
960a75e4 307#endif
9e165e74 308#ifdef HAVE_HW_ASIX_SIGMA
c09f0b57 309 &asix_sigma_driver_info,
5b907f9b 310#endif
9e165e74 311#ifdef HAVE_HW_CHRONOVU_LA8
c09f0b57 312 &chronovu_la8_driver_info,
f4314d7e 313#endif
9e165e74 314#ifdef HAVE_HW_LINK_MSO19
7ab89f48
UH
315 &link_mso19_driver_info,
316#endif
0254651d 317#ifdef HAVE_HW_ALSA
c09f0b57 318 &alsa_driver_info,
f302a082 319#endif
9e165e74 320#ifdef HAVE_HW_FX2LAFW
c09f0b57 321 &fx2lafw_driver_info,
3b533202
BV
322#endif
323#ifdef HAVE_HW_HANTEK_DSO
62bb8840 324 &hantek_dso_driver_info,
6ed4f044 325#endif
e93cdf42
BV
326#ifdef HAVE_HW_AGILENT_DMM
327 &agdmm_driver_info,
e7edd64f
BV
328#endif
329#ifdef HAVE_HW_FLUKE_DMM
330 &flukedmm_driver_info,
d375b3c3 331#endif
21a7f269 332#ifdef HAVE_HW_SERIAL_DMM
825da8b2 333 &bbcgm_m2110_driver_info,
f086b830 334 &digitek_dt4000zc_driver_info,
729b01f9 335 &tekpower_tp4000zc_driver_info,
ce3777ad 336 &metex_me31_driver_info,
f0ac4929 337 &peaktech_3410_driver_info,
5887c9cc 338 &mastech_mas345_driver_info,
6dca2f16 339 &va_va18b_driver_info,
a53da082 340 &metex_m3640d_driver_info,
88f544f2 341 &metex_m4650cr_driver_info,
a376ffea 342 &peaktech_4370_driver_info,
d4bd66a0 343 &pce_pce_dm32_driver_info,
d5ce233f 344 &radioshack_22_168_driver_info,
3864648b 345 &radioshack_22_805_driver_info,
21829e67 346 &radioshack_22_812_driver_info,
b38e08fb 347 &tecpel_dmm_8061_ser_driver_info,
5f2a4aff 348 &voltcraft_m3650d_driver_info,
2b83d7fe 349 &voltcraft_m4650cr_driver_info,
40830061 350 &voltcraft_vc820_ser_driver_info,
6045b91a 351 &voltcraft_vc830_ser_driver_info,
54d11221 352 &voltcraft_vc840_ser_driver_info,
a7a163a7
FK
353 &uni_t_ut60a_ser_driver_info,
354 &uni_t_ut60e_ser_driver_info,
ae3a59de 355 &uni_t_ut61d_ser_driver_info,
986fde75 356 &uni_t_ut61e_ser_driver_info,
df6b0f99 357 &iso_tech_idm103n_driver_info,
79081ec8
UH
358#endif
359#ifdef HAVE_HW_UNI_T_DMM
b6bad47c 360 &tecpel_dmm_8061_driver_info,
a7a163a7
FK
361 &uni_t_ut60a_driver_info,
362 &uni_t_ut60e_driver_info,
fdbcb86d 363 &uni_t_ut61d_driver_info,
bbef5e32 364 &uni_t_ut61e_driver_info,
fdbcb86d 365 &voltcraft_vc820_driver_info,
c1345749 366 &voltcraft_vc830_driver_info,
695d0e1e 367 &voltcraft_vc840_driver_info,
5e1f7c89 368 &tenma_72_7745_driver_info,
eb1f1eb4 369#endif
050e9219
UH
370 NULL,
371};
a1bb33af 372
a1645fcd 373/**
cfe064d8 374 * Return the list of supported hardware drivers.
a1645fcd 375 *
c09f0b57 376 * @return Pointer to the NULL-terminated list of hardware driver pointers.
a1645fcd 377 */
cfe064d8 378SR_API struct sr_dev_driver **sr_driver_list(void)
a1bb33af 379{
80bf0426 380
c09f0b57 381 return drivers_list;
a1bb33af
UH
382}
383
a1645fcd 384/**
c09f0b57 385 * Initialize a hardware driver.
a1645fcd 386 *
c0eea11c
UH
387 * This usually involves memory allocations and variable initializations
388 * within the driver, but _not_ scanning for attached devices.
389 * The API call sr_driver_scan() is used for that.
390 *
44fc870c 391 * @param ctx A libsigrok context object allocated by a previous call to
c0eea11c
UH
392 * sr_init(). Must not be NULL.
393 * @param driver The driver to initialize. This must be a pointer to one of
394 * the entries returned by sr_driver_list(). Must not be NULL.
a1645fcd 395 *
c0eea11c
UH
396 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
397 * SR_ERR_BUG upon internal errors, or another negative error code
398 * upon other errors.
a1645fcd 399 */
44fc870c 400SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
8722c31e 401{
c0eea11c
UH
402 int ret;
403
404 if (!ctx) {
405 sr_err("Invalid libsigrok context, can't initialize.");
406 return SR_ERR_ARG;
407 }
408
409 if (!driver) {
410 sr_err("Invalid driver, can't initialize.");
411 return SR_ERR_ARG;
412 }
8722c31e 413
c0eea11c
UH
414 sr_spew("Initializing driver '%s'.", driver->name);
415 if ((ret = driver->init(ctx)) < 0)
416 sr_err("Failed to initialize the driver: %d.", ret);
80bf0426 417
c0eea11c 418 return ret;
80bf0426
BV
419}
420
421/**
422 * Tell a hardware driver to scan for devices.
423 *
a5f2e707
BV
424 * In addition to the detection, the devices that are found are also
425 * initialized automatically. On some devices, this involves a firmware upload,
426 * or other such measures.
427 *
428 * The order in which the system is scanned for devices is not specified. The
429 * caller should not assume or rely on any specific order.
430 *
4b97c74e
UH
431 * Before calling sr_driver_scan(), the user must have previously initialized
432 * the driver by calling sr_driver_init().
80bf0426 433 *
4b97c74e
UH
434 * @param driver The driver that should scan. This must be a pointer to one of
435 * the entries returned by sr_driver_list(). Must not be NULL.
436 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
437 * scanner. Can be NULL/empty.
438 *
439 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
440 * found (or errors were encountered). This list must be freed by the
441 * caller using g_slist_free(), but without freeing the data pointed
442 * to in the list.
80bf0426
BV
443 */
444SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
445{
4b97c74e
UH
446 GSList *l;
447
448 if (!driver) {
449 sr_err("Invalid driver, can't scan for devices.");
450 return NULL;
451 }
452
453 if (!driver->priv) {
454 sr_err("Driver not initialized, can't scan for devices.");
455 return NULL;
456 }
457
458 l = driver->scan(options);
80bf0426 459
4b97c74e
UH
460 sr_spew("Scan of '%s' found %d devices.", driver->name,
461 g_slist_length(l));
80bf0426 462
4b97c74e 463 return l;
8722c31e
BV
464}
465
b4bd7088 466/** @private */
93a04e3b 467SR_PRIV void sr_hw_cleanup_all(void)
8722c31e 468{
050e9219 469 int i;
c09f0b57 470 struct sr_dev_driver **drivers;
8722c31e 471
cfe064d8 472 drivers = sr_driver_list();
c09f0b57
UH
473 for (i = 0; drivers[i]; i++) {
474 if (drivers[i]->cleanup)
475 drivers[i]->cleanup();
8722c31e 476 }
8722c31e
BV
477}
478
72a08bcc
BV
479/** A floating reference can be passed in for data.
480 * @private */
bc1c2f00 481SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
4c0e310c
BV
482{
483 struct sr_config *src;
484
485 if (!(src = g_try_malloc(sizeof(struct sr_config))))
486 return NULL;
487 src->key = key;
bc1c2f00 488 src->data = g_variant_ref_sink(data);
4c0e310c
BV
489
490 return src;
491}
492
72a08bcc 493/** @private */
722db131
BV
494SR_PRIV void sr_config_free(struct sr_config *src)
495{
496
497 if (!src || !src->data) {
498 sr_err("%s: invalid data!", __func__);
499 return;
500 }
501
502 g_variant_unref(src->data);
503 g_free(src);
504
505}
506
df123801
BV
507/**
508 * Returns information about the given driver or device instance.
509 *
510 * @param driver The sr_dev_driver struct to query.
57ecdbd7
BV
511 * @param sdi (optional) If the key is specific to a device, this must
512 * contain a pointer to the struct sr_dev_inst to be checked.
513 * Otherwise it must be NULL.
514 * @param probe_group The probe group on the device for which to list the
515 * values, or NULL.
cbadb856 516 * @param key The configuration key (SR_CONF_*).
bc1c2f00
BV
517 * @param data Pointer to a GVariant where the value will be stored. Must
518 * not be NULL. The caller is given ownership of the GVariant
519 * and must thus decrease the refcount after use. However if
520 * this function returns an error code, the field should be
521 * considered unused, and should not be unreferenced.
df123801
BV
522 *
523 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
cbadb856 524 * may be returned by the driver indicating it doesn't know that key,
df123801
BV
525 * but this is not to be flagged as an error by the caller; merely
526 * as an indication that it's not applicable.
527 */
8f996b89
ML
528SR_API int sr_config_get(const struct sr_dev_driver *driver,
529 const struct sr_dev_inst *sdi,
530 const struct sr_probe_group *probe_group,
531 int key, GVariant **data)
df123801
BV
532{
533 int ret;
534
cbadb856 535 if (!driver || !data)
df123801
BV
536 return SR_ERR;
537
6cefe516
BV
538 if (!driver->config_get)
539 return SR_ERR_ARG;
540
8f996b89 541 if ((ret = driver->config_get(key, data, sdi, probe_group)) == SR_OK) {
bc1c2f00
BV
542 /* Got a floating reference from the driver. Sink it here,
543 * caller will need to unref when done with it. */
544 g_variant_ref_sink(*data);
545 }
df123801
BV
546
547 return ret;
548}
549
cbadb856
BV
550/**
551 * Set a configuration key in a device instance.
552 *
553 * @param sdi The device instance.
57ecdbd7
BV
554 * @param probe_group The probe group on the device for which to list the
555 * values, or NULL.
cbadb856 556 * @param key The configuration key (SR_CONF_*).
bc1c2f00
BV
557 * @param data The new value for the key, as a GVariant with GVariantType
558 * appropriate to that key. A floating reference can be passed
559 * in; its refcount will be sunk and unreferenced after use.
cbadb856
BV
560 *
561 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
562 * may be returned by the driver indicating it doesn't know that key,
563 * but this is not to be flagged as an error by the caller; merely
564 * as an indication that it's not applicable.
565 */
8f996b89
ML
566SR_API int sr_config_set(const struct sr_dev_inst *sdi,
567 const struct sr_probe_group *probe_group,
568 int key, GVariant *data)
cbadb856
BV
569{
570 int ret;
571
bc1c2f00 572 g_variant_ref_sink(data);
cbadb856 573
bc1c2f00
BV
574 if (!sdi || !sdi->driver || !data)
575 ret = SR_ERR;
576 else if (!sdi->driver->config_set)
577 ret = SR_ERR_ARG;
578 else
8f996b89 579 ret = sdi->driver->config_set(key, data, sdi, probe_group);
cbadb856 580
bc1c2f00 581 g_variant_unref(data);
cbadb856
BV
582
583 return ret;
584}
585
586/**
587 * List all possible values for a configuration key.
588 *
589 * @param driver The sr_dev_driver struct to query.
57ecdbd7
BV
590 * @param sdi (optional) If the key is specific to a device, this must
591 * contain a pointer to the struct sr_dev_inst to be checked.
592 * @param probe_group The probe group on the device for which to list the
593 * values, or NULL.
cbadb856 594 * @param key The configuration key (SR_CONF_*).
bc1c2f00
BV
595 * @param data A pointer to a GVariant where the list will be stored. The
596 * caller is given ownership of the GVariant and must thus
597 * unref the GVariant after use. However if this function
598 * returns an error code, the field should be considered
599 * unused, and should not be unreferenced.
cbadb856
BV
600 *
601 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
602 * may be returned by the driver indicating it doesn't know that key,
603 * but this is not to be flagged as an error by the caller; merely
604 * as an indication that it's not applicable.
605 */
8f996b89
ML
606SR_API int sr_config_list(const struct sr_dev_driver *driver,
607 const struct sr_dev_inst *sdi,
608 const struct sr_probe_group *probe_group,
609 int key, GVariant **data)
c5fb502f
BV
610{
611 int ret;
612
6cefe516 613 if (!driver || !data)
bc1c2f00 614 ret = SR_ERR;
d8284802 615 else if (!driver->config_list)
6cefe516 616 ret = SR_ERR_ARG;
8f996b89 617 else if ((ret = driver->config_list(key, data, sdi, probe_group)) == SR_OK)
bc1c2f00 618 g_variant_ref_sink(*data);
c5fb502f
BV
619
620 return ret;
621}
622
8bfdc8c4 623/**
cbadb856 624 * Get information about a configuration key.
a1645fcd 625 *
ca0938c5 626 * @param key The configuration key.
15cb43d6 627 *
c89c1c9c 628 * @return A pointer to a struct sr_config_info, or NULL if the key
15cb43d6
BV
629 * was not found.
630 */
c89c1c9c 631SR_API const struct sr_config_info *sr_config_info_get(int key)
15cb43d6
BV
632{
633 int i;
634
c89c1c9c
BV
635 for (i = 0; sr_config_info_data[i].key; i++) {
636 if (sr_config_info_data[i].key == key)
637 return &sr_config_info_data[i];
15cb43d6
BV
638 }
639
640 return NULL;
641}
642
643/**
cbadb856 644 * Get information about an configuration key, by name.
15cb43d6 645 *
cbadb856 646 * @param optname The configuration key.
a1645fcd 647 *
c89c1c9c 648 * @return A pointer to a struct sr_config_info, or NULL if the key
15cb43d6 649 * was not found.
a1645fcd 650 */
c89c1c9c 651SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
a1bb33af 652{
a1bb33af
UH
653 int i;
654
c89c1c9c
BV
655 for (i = 0; sr_config_info_data[i].key; i++) {
656 if (!strcmp(sr_config_info_data[i].id, optname))
657 return &sr_config_info_data[i];
a1bb33af
UH
658 }
659
49d0ce50 660 return NULL;
a1bb33af
UH
661}
662
69cfcfc8 663/* Unnecessary level of indirection follows. */
544a4582 664
b4bd7088 665/** @private */
69cfcfc8 666SR_PRIV int sr_source_remove(int fd)
a1bb33af 667{
69cfcfc8 668 return sr_session_source_remove(fd);
a1bb33af
UH
669}
670
b4bd7088 671/** @private */
69cfcfc8
UH
672SR_PRIV int sr_source_add(int fd, int events, int timeout,
673 sr_receive_data_callback_t cb, void *cb_data)
a1bb33af 674{
69cfcfc8 675 return sr_session_source_add(fd, events, timeout, cb, cb_data);
a1bb33af 676}
7b870c38
UH
677
678/** @} */