]>
Commit | Line | Data |
---|---|---|
a1bb33af UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
c73d2ea4 | 4 | * Copyright (C) 2010-2012 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 | |
393fb9cb UH |
30 | /** |
31 | * @file | |
32 | * | |
33 | * Hardware driver handling in libsigrok. | |
34 | */ | |
35 | ||
7b870c38 UH |
36 | /** |
37 | * @defgroup grp_driver Hardware drivers | |
38 | * | |
39 | * Hardware driver handling in libsigrok. | |
40 | * | |
41 | * @{ | |
42 | */ | |
8bfdc8c4 | 43 | |
c89c1c9c | 44 | static struct sr_config_info sr_config_info_data[] = { |
1953564a | 45 | {SR_CONF_CONN, SR_T_CHAR, "conn", |
083d64f9 | 46 | "Connection", NULL}, |
1953564a | 47 | {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm", |
083d64f9 | 48 | "Serial communication", NULL}, |
1953564a | 49 | {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate", |
083d64f9 | 50 | "Sample rate", NULL}, |
1953564a | 51 | {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", |
083d64f9 | 52 | "Pre-trigger capture ratio", NULL}, |
1953564a | 53 | {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern", |
083d64f9 | 54 | "Pattern generator mode", NULL}, |
1953564a | 55 | {SR_CONF_RLE, SR_T_BOOL, "rle", |
083d64f9 | 56 | "Run Length Encoding", NULL}, |
1953564a | 57 | {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope", |
083d64f9 | 58 | "Trigger slope", NULL}, |
1953564a | 59 | {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource", |
083d64f9 | 60 | "Trigger source", NULL}, |
1953564a | 61 | {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", |
083d64f9 | 62 | "Horizontal trigger position", NULL}, |
1953564a | 63 | {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", |
083d64f9 | 64 | "Buffer size", NULL}, |
1953564a | 65 | {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", |
083d64f9 | 66 | "Time base", NULL}, |
1953564a | 67 | {SR_CONF_FILTER, SR_T_CHAR, "filter", |
083d64f9 | 68 | "Filter targets", NULL}, |
1953564a | 69 | {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", |
083d64f9 | 70 | "Volts/div", NULL}, |
1953564a | 71 | {SR_CONF_COUPLING, SR_T_CHAR, "coupling", |
083d64f9 BV |
72 | "Coupling", NULL}, |
73 | {0, 0, NULL, NULL, NULL}, | |
a1bb33af UH |
74 | }; |
75 | ||
b4bd7088 | 76 | /** @cond PRIVATE */ |
4d729ddc BV |
77 | #ifdef HAVE_HW_COLEAD_SLM |
78 | extern SR_PRIV struct sr_dev_driver colead_slm_driver_info; | |
79 | #endif | |
a61b0e6a | 80 | #ifdef HAVE_LA_DEMO |
c09f0b57 | 81 | extern SR_PRIV struct sr_dev_driver demo_driver_info; |
a61b0e6a | 82 | #endif |
46697e38 BV |
83 | #ifdef HAVE_HW_LASCAR_EL_USB |
84 | extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info; | |
85 | #endif | |
35a078bc BV |
86 | #ifdef HAVE_HW_NEXUS_OSCIPRIME |
87 | extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info; | |
88 | #endif | |
960a75e4 | 89 | #ifdef HAVE_LA_OLS |
c09f0b57 | 90 | extern SR_PRIV struct sr_dev_driver ols_driver_info; |
960a75e4 | 91 | #endif |
f4816ac6 ML |
92 | #ifdef HAVE_HW_RIGOL_DS1XX2 |
93 | extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info; | |
94 | #endif | |
aa2af324 UH |
95 | #ifdef HAVE_HW_TONDAJ_SL_814 |
96 | extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info; | |
97 | #endif | |
ac3898d2 BV |
98 | #ifdef HAVE_HW_VICTOR_DMM |
99 | extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info; | |
100 | #endif | |
960a75e4 | 101 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE |
c09f0b57 | 102 | extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info; |
960a75e4 | 103 | #endif |
5b907f9b | 104 | #ifdef HAVE_LA_ASIX_SIGMA |
c09f0b57 | 105 | extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info; |
5b907f9b | 106 | #endif |
f4314d7e | 107 | #ifdef HAVE_LA_CHRONOVU_LA8 |
c09f0b57 | 108 | extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; |
f4314d7e | 109 | #endif |
bffed4fc | 110 | #ifdef HAVE_LA_LINK_MSO19 |
c09f0b57 | 111 | extern SR_PRIV struct sr_dev_driver link_mso19_driver_info; |
bffed4fc | 112 | #endif |
0254651d | 113 | #ifdef HAVE_HW_ALSA |
c09f0b57 | 114 | extern SR_PRIV struct sr_dev_driver alsa_driver_info; |
6ed4f044 | 115 | #endif |
f302a082 | 116 | #ifdef HAVE_LA_FX2LAFW |
c09f0b57 | 117 | extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info; |
f302a082 | 118 | #endif |
3b533202 | 119 | #ifdef HAVE_HW_HANTEK_DSO |
62bb8840 | 120 | extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info; |
3b533202 | 121 | #endif |
e93cdf42 BV |
122 | #ifdef HAVE_HW_AGILENT_DMM |
123 | extern SR_PRIV struct sr_dev_driver agdmm_driver_info; | |
124 | #endif | |
e7edd64f BV |
125 | #ifdef HAVE_HW_FLUKE_DMM |
126 | extern SR_PRIV struct sr_dev_driver flukedmm_driver_info; | |
127 | #endif | |
21a7f269 | 128 | #ifdef HAVE_HW_SERIAL_DMM |
f086b830 | 129 | extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info; |
729b01f9 | 130 | extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info; |
ce3777ad | 131 | extern SR_PRIV struct sr_dev_driver metex_me31_driver_info; |
f0ac4929 | 132 | extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info; |
5887c9cc | 133 | extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info; |
6dca2f16 | 134 | extern SR_PRIV struct sr_dev_driver va_va18b_driver_info; |
a53da082 | 135 | extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info; |
a376ffea | 136 | extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info; |
d4bd66a0 | 137 | extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info; |
d5ce233f | 138 | extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info; |
21829e67 | 139 | extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info; |
40830061 | 140 | extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info; |
54d11221 | 141 | extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info; |
986fde75 | 142 | extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info; |
7dc55d93 | 143 | #endif |
79081ec8 | 144 | #ifdef HAVE_HW_UNI_T_DMM |
fdbcb86d UH |
145 | extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info; |
146 | extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info; | |
79081ec8 | 147 | #endif |
b4bd7088 | 148 | /** @endcond */ |
6ed4f044 | 149 | |
c09f0b57 | 150 | static struct sr_dev_driver *drivers_list[] = { |
4d729ddc BV |
151 | #ifdef HAVE_HW_COLEAD_SLM |
152 | &colead_slm_driver_info, | |
153 | #endif | |
a61b0e6a | 154 | #ifdef HAVE_LA_DEMO |
c09f0b57 | 155 | &demo_driver_info, |
a61b0e6a | 156 | #endif |
46697e38 BV |
157 | #ifdef HAVE_HW_LASCAR_EL_USB |
158 | &lascar_el_usb_driver_info, | |
159 | #endif | |
35a078bc BV |
160 | #ifdef HAVE_HW_NEXUS_OSCIPRIME |
161 | &nexus_osciprime_driver_info, | |
162 | #endif | |
960a75e4 | 163 | #ifdef HAVE_LA_OLS |
c09f0b57 | 164 | &ols_driver_info, |
960a75e4 | 165 | #endif |
f4816ac6 ML |
166 | #ifdef HAVE_HW_RIGOL_DS1XX2 |
167 | &rigol_ds1xx2_driver_info, | |
168 | #endif | |
aa2af324 UH |
169 | #ifdef HAVE_HW_TONDAJ_SL_814 |
170 | &tondaj_sl_814_driver_info, | |
171 | #endif | |
ac3898d2 BV |
172 | #ifdef HAVE_HW_VICTOR_DMM |
173 | &victor_dmm_driver_info, | |
174 | #endif | |
960a75e4 | 175 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE |
c09f0b57 | 176 | &zeroplus_logic_cube_driver_info, |
960a75e4 | 177 | #endif |
5b907f9b | 178 | #ifdef HAVE_LA_ASIX_SIGMA |
c09f0b57 | 179 | &asix_sigma_driver_info, |
5b907f9b | 180 | #endif |
f4314d7e | 181 | #ifdef HAVE_LA_CHRONOVU_LA8 |
c09f0b57 | 182 | &chronovu_la8_driver_info, |
f4314d7e | 183 | #endif |
bffed4fc | 184 | #ifdef HAVE_LA_LINK_MSO19 |
c09f0b57 | 185 | &link_mso19_driver_info, |
bffed4fc | 186 | #endif |
0254651d | 187 | #ifdef HAVE_HW_ALSA |
c09f0b57 | 188 | &alsa_driver_info, |
f302a082 JH |
189 | #endif |
190 | #ifdef HAVE_LA_FX2LAFW | |
c09f0b57 | 191 | &fx2lafw_driver_info, |
3b533202 BV |
192 | #endif |
193 | #ifdef HAVE_HW_HANTEK_DSO | |
62bb8840 | 194 | &hantek_dso_driver_info, |
6ed4f044 | 195 | #endif |
e93cdf42 BV |
196 | #ifdef HAVE_HW_AGILENT_DMM |
197 | &agdmm_driver_info, | |
e7edd64f BV |
198 | #endif |
199 | #ifdef HAVE_HW_FLUKE_DMM | |
200 | &flukedmm_driver_info, | |
d375b3c3 | 201 | #endif |
21a7f269 | 202 | #ifdef HAVE_HW_SERIAL_DMM |
f086b830 | 203 | &digitek_dt4000zc_driver_info, |
729b01f9 | 204 | &tekpower_tp4000zc_driver_info, |
ce3777ad | 205 | &metex_me31_driver_info, |
f0ac4929 | 206 | &peaktech_3410_driver_info, |
5887c9cc | 207 | &mastech_mas345_driver_info, |
6dca2f16 | 208 | &va_va18b_driver_info, |
a53da082 | 209 | &metex_m3640d_driver_info, |
a376ffea | 210 | &peaktech_4370_driver_info, |
d4bd66a0 | 211 | &pce_pce_dm32_driver_info, |
d5ce233f | 212 | &radioshack_22_168_driver_info, |
21829e67 | 213 | &radioshack_22_812_driver_info, |
40830061 | 214 | &voltcraft_vc820_ser_driver_info, |
54d11221 | 215 | &voltcraft_vc840_ser_driver_info, |
986fde75 | 216 | &uni_t_ut61e_ser_driver_info, |
79081ec8 UH |
217 | #endif |
218 | #ifdef HAVE_HW_UNI_T_DMM | |
fdbcb86d UH |
219 | &uni_t_ut61d_driver_info, |
220 | &voltcraft_vc820_driver_info, | |
eb1f1eb4 | 221 | #endif |
050e9219 UH |
222 | NULL, |
223 | }; | |
a1bb33af | 224 | |
a1645fcd | 225 | /** |
cfe064d8 | 226 | * Return the list of supported hardware drivers. |
a1645fcd | 227 | * |
c09f0b57 | 228 | * @return Pointer to the NULL-terminated list of hardware driver pointers. |
a1645fcd | 229 | */ |
cfe064d8 | 230 | SR_API struct sr_dev_driver **sr_driver_list(void) |
a1bb33af | 231 | { |
80bf0426 | 232 | |
c09f0b57 | 233 | return drivers_list; |
a1bb33af UH |
234 | } |
235 | ||
a1645fcd | 236 | /** |
c09f0b57 | 237 | * Initialize a hardware driver. |
a1645fcd | 238 | * |
44fc870c PS |
239 | * @param ctx A libsigrok context object allocated by a previous call to |
240 | * sr_init(). | |
c09f0b57 | 241 | * @param driver The driver to initialize. |
a1645fcd | 242 | * |
80bf0426 | 243 | * @return SR_OK if all went well, or an error code otherwise. |
a1645fcd | 244 | */ |
44fc870c | 245 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) |
8722c31e | 246 | { |
8722c31e | 247 | |
80bf0426 | 248 | if (driver->init) |
34f06b90 | 249 | return driver->init(ctx); |
80bf0426 BV |
250 | |
251 | return SR_OK; | |
252 | } | |
253 | ||
254 | /** | |
255 | * Tell a hardware driver to scan for devices. | |
256 | * | |
a5f2e707 BV |
257 | * In addition to the detection, the devices that are found are also |
258 | * initialized automatically. On some devices, this involves a firmware upload, | |
259 | * or other such measures. | |
260 | * | |
261 | * The order in which the system is scanned for devices is not specified. The | |
262 | * caller should not assume or rely on any specific order. | |
263 | * | |
80bf0426 BV |
264 | * @param driver The driver. |
265 | * @param options A list of struct sr_hwopt options to pass to the driver's | |
266 | * scanner. | |
267 | * | |
268 | * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found. | |
269 | * This list must be freed by the caller, but without freeing the data | |
270 | * pointed to in the list. | |
271 | */ | |
272 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
273 | { | |
274 | ||
275 | if (driver->scan) | |
276 | return driver->scan(options); | |
277 | ||
278 | return NULL; | |
8722c31e BV |
279 | } |
280 | ||
b4bd7088 | 281 | /** @private */ |
93a04e3b | 282 | SR_PRIV void sr_hw_cleanup_all(void) |
8722c31e | 283 | { |
050e9219 | 284 | int i; |
c09f0b57 | 285 | struct sr_dev_driver **drivers; |
8722c31e | 286 | |
cfe064d8 | 287 | drivers = sr_driver_list(); |
c09f0b57 UH |
288 | for (i = 0; drivers[i]; i++) { |
289 | if (drivers[i]->cleanup) | |
290 | drivers[i]->cleanup(); | |
8722c31e | 291 | } |
8722c31e BV |
292 | } |
293 | ||
4c0e310c BV |
294 | SR_PRIV struct sr_config *sr_config_make(int key, const void *value) |
295 | { | |
296 | struct sr_config *src; | |
297 | ||
298 | if (!(src = g_try_malloc(sizeof(struct sr_config)))) | |
299 | return NULL; | |
300 | src->key = key; | |
301 | src->value = value; | |
302 | ||
303 | return src; | |
304 | } | |
305 | ||
df123801 BV |
306 | /** |
307 | * Returns information about the given driver or device instance. | |
308 | * | |
309 | * @param driver The sr_dev_driver struct to query. | |
1953564a | 310 | * @param id The type of information, in the form of an SR_CONF_* option. |
df123801 BV |
311 | * @param data Pointer where the value. will be stored. Must not be NULL. |
312 | * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL. | |
313 | * | |
314 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
315 | * may be returned by the driver indicating it doesn't know that id, | |
316 | * but this is not to be flagged as an error by the caller; merely | |
317 | * as an indication that it's not applicable. | |
318 | */ | |
319 | SR_API int sr_info_get(struct sr_dev_driver *driver, int id, | |
320 | const void **data, const struct sr_dev_inst *sdi) | |
321 | { | |
322 | int ret; | |
323 | ||
324 | if (driver == NULL || data == NULL) | |
325 | return SR_ERR; | |
326 | ||
035a1078 | 327 | ret = driver->config_get(id, data, sdi); |
df123801 BV |
328 | |
329 | return ret; | |
330 | } | |
331 | ||
c5fb502f BV |
332 | SR_API int sr_config_list(struct sr_dev_driver *driver, int id, |
333 | const void **data, const struct sr_dev_inst *sdi) | |
334 | { | |
335 | int ret; | |
336 | ||
337 | if (driver == NULL || data == NULL) | |
338 | return SR_ERR; | |
339 | ||
340 | if (!driver->config_list) | |
341 | return SR_ERR; | |
342 | ||
343 | ret = driver->config_list(id, data, sdi); | |
344 | ||
345 | return ret; | |
346 | } | |
347 | ||
a1645fcd | 348 | /** |
c09f0b57 | 349 | * Find out if a hardware driver has a specific capability. |
a1645fcd | 350 | * |
c09f0b57 | 351 | * @param driver The hardware driver in which to search for the capability. |
a1645fcd BV |
352 | * @param hwcap The capability to find in the list. |
353 | * | |
c496ac97 UH |
354 | * @return TRUE if the specified capability exists in the specified driver, |
355 | * FALSE otherwise. Also, if 'driver' is NULL or the respective driver | |
356 | * returns an invalid capability list, FALSE is returned. | |
a1645fcd | 357 | */ |
cfe064d8 | 358 | SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) |
a1bb33af | 359 | { |
915f7cc8 JH |
360 | const int *hwcaps; |
361 | int i; | |
a1bb33af | 362 | |
c496ac97 UH |
363 | if (!driver) { |
364 | sr_err("hwdriver: %s: driver was NULL", __func__); | |
365 | return FALSE; | |
366 | } | |
367 | ||
035a1078 | 368 | if (driver->config_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) |
c496ac97 | 369 | return FALSE; |
c496ac97 | 370 | |
ffedd0bf UH |
371 | for (i = 0; hwcaps[i]; i++) { |
372 | if (hwcaps[i] == hwcap) | |
a1bb33af | 373 | return TRUE; |
49d0ce50 | 374 | } |
a1bb33af UH |
375 | |
376 | return FALSE; | |
377 | } | |
378 | ||
8bfdc8c4 | 379 | /** |
c89c1c9c | 380 | * Get information about an sr_config key. |
a1645fcd | 381 | * |
c89c1c9c | 382 | * @param opt The sr_config key. |
15cb43d6 | 383 | * |
c89c1c9c | 384 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 BV |
385 | * was not found. |
386 | */ | |
c89c1c9c | 387 | SR_API const struct sr_config_info *sr_config_info_get(int key) |
15cb43d6 BV |
388 | { |
389 | int i; | |
390 | ||
c89c1c9c BV |
391 | for (i = 0; sr_config_info_data[i].key; i++) { |
392 | if (sr_config_info_data[i].key == key) | |
393 | return &sr_config_info_data[i]; | |
15cb43d6 BV |
394 | } |
395 | ||
396 | return NULL; | |
397 | } | |
398 | ||
399 | /** | |
c89c1c9c | 400 | * Get information about an sr_config key, by name. |
15cb43d6 | 401 | * |
c89c1c9c | 402 | * @param optname The sr_config key. |
a1645fcd | 403 | * |
c89c1c9c | 404 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 405 | * was not found. |
a1645fcd | 406 | */ |
c89c1c9c | 407 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) |
a1bb33af | 408 | { |
a1bb33af UH |
409 | int i; |
410 | ||
c89c1c9c BV |
411 | for (i = 0; sr_config_info_data[i].key; i++) { |
412 | if (!strcmp(sr_config_info_data[i].id, optname)) | |
413 | return &sr_config_info_data[i]; | |
a1bb33af UH |
414 | } |
415 | ||
49d0ce50 | 416 | return NULL; |
a1bb33af UH |
417 | } |
418 | ||
69cfcfc8 | 419 | /* Unnecessary level of indirection follows. */ |
544a4582 | 420 | |
b4bd7088 | 421 | /** @private */ |
69cfcfc8 | 422 | SR_PRIV int sr_source_remove(int fd) |
a1bb33af | 423 | { |
69cfcfc8 | 424 | return sr_session_source_remove(fd); |
a1bb33af UH |
425 | } |
426 | ||
b4bd7088 | 427 | /** @private */ |
69cfcfc8 UH |
428 | SR_PRIV int sr_source_add(int fd, int events, int timeout, |
429 | sr_receive_data_callback_t cb, void *cb_data) | |
a1bb33af | 430 | { |
69cfcfc8 | 431 | return sr_session_source_add(fd, events, timeout, cb, cb_data); |
a1bb33af | 432 | } |
7b870c38 UH |
433 | |
434 | /** @} */ |