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