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