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