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