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