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