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