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