]>
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 */ |
a61b0e6a | 71 | #ifdef HAVE_LA_DEMO |
c09f0b57 | 72 | extern SR_PRIV struct sr_dev_driver demo_driver_info; |
a61b0e6a | 73 | #endif |
960a75e4 | 74 | #ifdef HAVE_LA_OLS |
c09f0b57 | 75 | extern SR_PRIV struct sr_dev_driver ols_driver_info; |
960a75e4 UH |
76 | #endif |
77 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE | |
c09f0b57 | 78 | extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info; |
960a75e4 | 79 | #endif |
5b907f9b | 80 | #ifdef HAVE_LA_ASIX_SIGMA |
c09f0b57 | 81 | extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info; |
5b907f9b | 82 | #endif |
f4314d7e | 83 | #ifdef HAVE_LA_CHRONOVU_LA8 |
c09f0b57 | 84 | extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; |
f4314d7e | 85 | #endif |
bffed4fc | 86 | #ifdef HAVE_LA_LINK_MSO19 |
c09f0b57 | 87 | extern SR_PRIV struct sr_dev_driver link_mso19_driver_info; |
bffed4fc | 88 | #endif |
6ed4f044 | 89 | #ifdef HAVE_LA_ALSA |
c09f0b57 | 90 | extern SR_PRIV struct sr_dev_driver alsa_driver_info; |
6ed4f044 | 91 | #endif |
f302a082 | 92 | #ifdef HAVE_LA_FX2LAFW |
c09f0b57 | 93 | extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info; |
f302a082 | 94 | #endif |
3b533202 | 95 | #ifdef HAVE_HW_HANTEK_DSO |
62bb8840 | 96 | extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info; |
3b533202 | 97 | #endif |
ca3d84cc BV |
98 | #ifdef HAVE_HW_GENERICDMM |
99 | extern SR_PRIV struct sr_dev_driver genericdmm_driver_info; | |
100 | #endif | |
e93cdf42 BV |
101 | #ifdef HAVE_HW_AGILENT_DMM |
102 | extern SR_PRIV struct sr_dev_driver agdmm_driver_info; | |
103 | #endif | |
e7edd64f BV |
104 | #ifdef HAVE_HW_FLUKE_DMM |
105 | extern SR_PRIV struct sr_dev_driver flukedmm_driver_info; | |
106 | #endif | |
d375b3c3 AG |
107 | #ifdef HAVE_HW_RADIOSHACK_DMM |
108 | extern SR_PRIV struct sr_dev_driver radioshackdmm_driver_info; | |
109 | #endif | |
7dc55d93 | 110 | #ifdef HAVE_HW_TEKPOWER_DMM |
bbabddbd | 111 | extern SR_PRIV struct sr_dev_driver tekpower_dmm_driver_info; |
7dc55d93 | 112 | #endif |
79081ec8 | 113 | #ifdef HAVE_HW_UNI_T_DMM |
fdbcb86d UH |
114 | extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info; |
115 | extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info; | |
79081ec8 | 116 | #endif |
b4bd7088 | 117 | /** @endcond */ |
6ed4f044 | 118 | |
c09f0b57 | 119 | static struct sr_dev_driver *drivers_list[] = { |
a61b0e6a | 120 | #ifdef HAVE_LA_DEMO |
c09f0b57 | 121 | &demo_driver_info, |
a61b0e6a | 122 | #endif |
960a75e4 | 123 | #ifdef HAVE_LA_OLS |
c09f0b57 | 124 | &ols_driver_info, |
960a75e4 UH |
125 | #endif |
126 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE | |
c09f0b57 | 127 | &zeroplus_logic_cube_driver_info, |
960a75e4 | 128 | #endif |
5b907f9b | 129 | #ifdef HAVE_LA_ASIX_SIGMA |
c09f0b57 | 130 | &asix_sigma_driver_info, |
5b907f9b | 131 | #endif |
f4314d7e | 132 | #ifdef HAVE_LA_CHRONOVU_LA8 |
c09f0b57 | 133 | &chronovu_la8_driver_info, |
f4314d7e | 134 | #endif |
bffed4fc | 135 | #ifdef HAVE_LA_LINK_MSO19 |
c09f0b57 | 136 | &link_mso19_driver_info, |
bffed4fc | 137 | #endif |
6ed4f044 | 138 | #ifdef HAVE_LA_ALSA |
c09f0b57 | 139 | &alsa_driver_info, |
f302a082 JH |
140 | #endif |
141 | #ifdef HAVE_LA_FX2LAFW | |
c09f0b57 | 142 | &fx2lafw_driver_info, |
3b533202 BV |
143 | #endif |
144 | #ifdef HAVE_HW_HANTEK_DSO | |
62bb8840 | 145 | &hantek_dso_driver_info, |
6ed4f044 | 146 | #endif |
ca3d84cc BV |
147 | #ifdef HAVE_HW_GENERICDMM |
148 | &genericdmm_driver_info, | |
e93cdf42 BV |
149 | #endif |
150 | #ifdef HAVE_HW_AGILENT_DMM | |
151 | &agdmm_driver_info, | |
e7edd64f BV |
152 | #endif |
153 | #ifdef HAVE_HW_FLUKE_DMM | |
154 | &flukedmm_driver_info, | |
d375b3c3 AG |
155 | #endif |
156 | #ifdef HAVE_HW_RADIOSHACK_DMM | |
157 | &radioshackdmm_driver_info, | |
7dc55d93 AG |
158 | #endif |
159 | #ifdef HAVE_HW_TEKPOWER_DMM | |
bbabddbd | 160 | &tekpower_dmm_driver_info, |
79081ec8 UH |
161 | #endif |
162 | #ifdef HAVE_HW_UNI_T_DMM | |
fdbcb86d UH |
163 | &uni_t_ut61d_driver_info, |
164 | &voltcraft_vc820_driver_info, | |
eb1f1eb4 | 165 | #endif |
050e9219 UH |
166 | NULL, |
167 | }; | |
a1bb33af | 168 | |
a1645fcd | 169 | /** |
cfe064d8 | 170 | * Return the list of supported hardware drivers. |
a1645fcd | 171 | * |
c09f0b57 | 172 | * @return Pointer to the NULL-terminated list of hardware driver pointers. |
a1645fcd | 173 | */ |
cfe064d8 | 174 | SR_API struct sr_dev_driver **sr_driver_list(void) |
a1bb33af | 175 | { |
80bf0426 | 176 | |
c09f0b57 | 177 | return drivers_list; |
a1bb33af UH |
178 | } |
179 | ||
a1645fcd | 180 | /** |
c09f0b57 | 181 | * Initialize a hardware driver. |
a1645fcd | 182 | * |
c09f0b57 | 183 | * @param driver The driver to initialize. |
a1645fcd | 184 | * |
80bf0426 | 185 | * @return SR_OK if all went well, or an error code otherwise. |
a1645fcd | 186 | */ |
cfe064d8 | 187 | SR_API int sr_driver_init(struct sr_dev_driver *driver) |
8722c31e | 188 | { |
8722c31e | 189 | |
80bf0426 BV |
190 | if (driver->init) |
191 | return driver->init(); | |
192 | ||
193 | return SR_OK; | |
194 | } | |
195 | ||
196 | /** | |
197 | * Tell a hardware driver to scan for devices. | |
198 | * | |
a5f2e707 BV |
199 | * In addition to the detection, the devices that are found are also |
200 | * initialized automatically. On some devices, this involves a firmware upload, | |
201 | * or other such measures. | |
202 | * | |
203 | * The order in which the system is scanned for devices is not specified. The | |
204 | * caller should not assume or rely on any specific order. | |
205 | * | |
80bf0426 BV |
206 | * @param driver The driver. |
207 | * @param options A list of struct sr_hwopt options to pass to the driver's | |
208 | * scanner. | |
209 | * | |
210 | * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found. | |
211 | * This list must be freed by the caller, but without freeing the data | |
212 | * pointed to in the list. | |
213 | */ | |
214 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
215 | { | |
216 | ||
217 | if (driver->scan) | |
218 | return driver->scan(options); | |
219 | ||
220 | return NULL; | |
8722c31e BV |
221 | } |
222 | ||
b4bd7088 | 223 | /** @private */ |
93a04e3b | 224 | SR_PRIV void sr_hw_cleanup_all(void) |
8722c31e | 225 | { |
050e9219 | 226 | int i; |
c09f0b57 | 227 | struct sr_dev_driver **drivers; |
8722c31e | 228 | |
cfe064d8 | 229 | drivers = sr_driver_list(); |
c09f0b57 UH |
230 | for (i = 0; drivers[i]; i++) { |
231 | if (drivers[i]->cleanup) | |
232 | drivers[i]->cleanup(); | |
8722c31e | 233 | } |
8722c31e BV |
234 | } |
235 | ||
df123801 BV |
236 | /** |
237 | * Returns information about the given driver or device instance. | |
238 | * | |
239 | * @param driver The sr_dev_driver struct to query. | |
240 | * @param id The type of information, in the form of an SR_HWCAP_* option. | |
241 | * @param data Pointer where the value. will be stored. Must not be NULL. | |
242 | * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL. | |
243 | * | |
244 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
245 | * may be returned by the driver indicating it doesn't know that id, | |
246 | * but this is not to be flagged as an error by the caller; merely | |
247 | * as an indication that it's not applicable. | |
248 | */ | |
249 | SR_API int sr_info_get(struct sr_dev_driver *driver, int id, | |
250 | const void **data, const struct sr_dev_inst *sdi) | |
251 | { | |
252 | int ret; | |
253 | ||
254 | if (driver == NULL || data == NULL) | |
255 | return SR_ERR; | |
256 | ||
257 | ret = driver->info_get(id, data, sdi); | |
258 | ||
259 | return ret; | |
260 | } | |
261 | ||
a1645fcd | 262 | /** |
c09f0b57 | 263 | * Find out if a hardware driver has a specific capability. |
a1645fcd | 264 | * |
c09f0b57 | 265 | * @param driver The hardware driver in which to search for the capability. |
a1645fcd BV |
266 | * @param hwcap The capability to find in the list. |
267 | * | |
c496ac97 UH |
268 | * @return TRUE if the specified capability exists in the specified driver, |
269 | * FALSE otherwise. Also, if 'driver' is NULL or the respective driver | |
270 | * returns an invalid capability list, FALSE is returned. | |
a1645fcd | 271 | */ |
cfe064d8 | 272 | SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) |
a1bb33af | 273 | { |
915f7cc8 JH |
274 | const int *hwcaps; |
275 | int i; | |
a1bb33af | 276 | |
c496ac97 UH |
277 | if (!driver) { |
278 | sr_err("hwdriver: %s: driver was NULL", __func__); | |
279 | return FALSE; | |
280 | } | |
281 | ||
be34a1c7 | 282 | if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) |
c496ac97 | 283 | return FALSE; |
c496ac97 | 284 | |
ffedd0bf UH |
285 | for (i = 0; hwcaps[i]; i++) { |
286 | if (hwcaps[i] == hwcap) | |
a1bb33af | 287 | return TRUE; |
49d0ce50 | 288 | } |
a1bb33af UH |
289 | |
290 | return FALSE; | |
291 | } | |
292 | ||
8bfdc8c4 | 293 | /** |
48a486cd | 294 | * Get information about a hardware driver option. |
8bfdc8c4 | 295 | * |
15cb43d6 | 296 | * @param opt The option to get. |
8bfdc8c4 | 297 | * |
15cb43d6 BV |
298 | * @return A pointer to a struct sr_hwcap_option, or NULL if the option |
299 | * was not found. | |
8bfdc8c4 | 300 | */ |
15cb43d6 | 301 | SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt) |
8bfdc8c4 BV |
302 | { |
303 | int i; | |
304 | ||
305 | for (i = 0; sr_drvopts[i].hwcap; i++) { | |
15cb43d6 BV |
306 | if (sr_drvopts[i].hwcap == opt) |
307 | return &sr_drvopts[i]; | |
308 | } | |
309 | ||
310 | return NULL; | |
311 | } | |
312 | ||
313 | /** | |
314 | * Get information about a hardware driver option, by name. | |
315 | * | |
316 | * @param optname The name of the option to get. | |
317 | * | |
318 | * @return A pointer to a struct sr_hwcap_option, or NULL if the option | |
319 | * was not found. | |
320 | */ | |
321 | SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname) | |
322 | { | |
323 | int i; | |
324 | ||
325 | for (i = 0; sr_drvopts[i].hwcap; i++) { | |
326 | if (!strcmp(sr_drvopts[i].shortname, optname)) | |
8bfdc8c4 BV |
327 | return &sr_drvopts[i]; |
328 | } | |
329 | ||
330 | return NULL; | |
331 | } | |
332 | ||
a1645fcd | 333 | /** |
48a486cd | 334 | * Get information about a device option. |
a1645fcd | 335 | * |
15cb43d6 BV |
336 | * @param opt The option to get. |
337 | * | |
338 | * @return A pointer to a struct sr_hwcap_option, or NULL if the option | |
339 | * was not found. | |
340 | */ | |
341 | SR_API const struct sr_hwcap_option *sr_devopt_get(int opt) | |
342 | { | |
343 | int i; | |
344 | ||
345 | for (i = 0; sr_devopts[i].hwcap; i++) { | |
346 | if (sr_devopts[i].hwcap == opt) | |
347 | return &sr_devopts[i]; | |
348 | } | |
349 | ||
350 | return NULL; | |
351 | } | |
352 | ||
353 | /** | |
354 | * Get information about a device option, by name. | |
355 | * | |
356 | * @param optname The name of the option to get. | |
a1645fcd | 357 | * |
15cb43d6 BV |
358 | * @return A pointer to a struct sr_hwcap_option, or NULL if the option |
359 | * was not found. | |
a1645fcd | 360 | */ |
15cb43d6 | 361 | SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname) |
a1bb33af | 362 | { |
a1bb33af UH |
363 | int i; |
364 | ||
15cb43d6 BV |
365 | for (i = 0; sr_devopts[i].hwcap; i++) { |
366 | if (!strcmp(sr_devopts[i].shortname, optname)) | |
367 | return &sr_devopts[i]; | |
a1bb33af UH |
368 | } |
369 | ||
49d0ce50 | 370 | return NULL; |
a1bb33af UH |
371 | } |
372 | ||
69cfcfc8 | 373 | /* Unnecessary level of indirection follows. */ |
544a4582 | 374 | |
b4bd7088 | 375 | /** @private */ |
69cfcfc8 | 376 | SR_PRIV int sr_source_remove(int fd) |
a1bb33af | 377 | { |
69cfcfc8 | 378 | return sr_session_source_remove(fd); |
a1bb33af UH |
379 | } |
380 | ||
b4bd7088 | 381 | /** @private */ |
69cfcfc8 UH |
382 | SR_PRIV int sr_source_add(int fd, int events, int timeout, |
383 | sr_receive_data_callback_t cb, void *cb_data) | |
a1bb33af | 384 | { |
69cfcfc8 | 385 | return sr_session_source_add(fd, events, timeout, cb, cb_data); |
a1bb33af | 386 | } |
7b870c38 UH |
387 | |
388 | /** @} */ |