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