]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> | |
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> | |
26 | #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ | |
27 | #include "libsigrok.h" | |
28 | #include "libsigrok-internal.h" | |
29 | ||
30 | /** | |
31 | * @file | |
32 | * | |
33 | * Hardware driver handling in libsigrok. | |
34 | */ | |
35 | ||
36 | /** | |
37 | * @defgroup grp_driver Hardware drivers | |
38 | * | |
39 | * Hardware driver handling in libsigrok. | |
40 | * | |
41 | * @{ | |
42 | */ | |
43 | ||
44 | /* Driver scanning options. */ | |
45 | static struct sr_hwcap_option sr_drvopts[] = { | |
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"}, | |
49 | {0, 0, NULL, NULL}, | |
50 | }; | |
51 | ||
52 | /* Device instance options. */ | |
53 | static struct sr_hwcap_option sr_devopts[] = { | |
54 | {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"}, | |
55 | {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"}, | |
56 | {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"}, | |
57 | {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"}, | |
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"}, | |
63 | {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"}, | |
64 | {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"}, | |
65 | {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"}, | |
66 | {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"}, | |
67 | {0, 0, NULL, NULL}, | |
68 | }; | |
69 | ||
70 | /** @cond PRIVATE */ | |
71 | #ifdef HAVE_HW_COLEAD_SLM | |
72 | extern SR_PRIV struct sr_dev_driver colead_slm_driver_info; | |
73 | #endif | |
74 | #ifdef HAVE_LA_DEMO | |
75 | extern SR_PRIV struct sr_dev_driver demo_driver_info; | |
76 | #endif | |
77 | #ifdef HAVE_LA_OLS | |
78 | extern SR_PRIV struct sr_dev_driver ols_driver_info; | |
79 | #endif | |
80 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE | |
81 | extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info; | |
82 | #endif | |
83 | #ifdef HAVE_LA_ASIX_SIGMA | |
84 | extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info; | |
85 | #endif | |
86 | #ifdef HAVE_LA_CHRONOVU_LA8 | |
87 | extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; | |
88 | #endif | |
89 | #ifdef HAVE_LA_LINK_MSO19 | |
90 | extern SR_PRIV struct sr_dev_driver link_mso19_driver_info; | |
91 | #endif | |
92 | #ifdef HAVE_LA_ALSA | |
93 | extern SR_PRIV struct sr_dev_driver alsa_driver_info; | |
94 | #endif | |
95 | #ifdef HAVE_LA_FX2LAFW | |
96 | extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info; | |
97 | #endif | |
98 | #ifdef HAVE_HW_HANTEK_DSO | |
99 | extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info; | |
100 | #endif | |
101 | #ifdef HAVE_HW_GENERICDMM | |
102 | extern SR_PRIV struct sr_dev_driver genericdmm_driver_info; | |
103 | #endif | |
104 | #ifdef HAVE_HW_AGILENT_DMM | |
105 | extern SR_PRIV struct sr_dev_driver agdmm_driver_info; | |
106 | #endif | |
107 | #ifdef HAVE_HW_FLUKE_DMM | |
108 | extern SR_PRIV struct sr_dev_driver flukedmm_driver_info; | |
109 | #endif | |
110 | #ifdef HAVE_HW_RADIOSHACK_DMM | |
111 | extern SR_PRIV struct sr_dev_driver radioshackdmm_driver_info; | |
112 | #endif | |
113 | #ifdef HAVE_HW_TEKPOWER_DMM | |
114 | extern SR_PRIV struct sr_dev_driver tekpower_dmm_driver_info; | |
115 | #endif | |
116 | #ifdef HAVE_HW_UNI_T_DMM | |
117 | extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info; | |
118 | extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info; | |
119 | #endif | |
120 | /** @endcond */ | |
121 | ||
122 | static struct sr_dev_driver *drivers_list[] = { | |
123 | #ifdef HAVE_HW_COLEAD_SLM | |
124 | &colead_slm_driver_info, | |
125 | #endif | |
126 | #ifdef HAVE_LA_DEMO | |
127 | &demo_driver_info, | |
128 | #endif | |
129 | #ifdef HAVE_LA_OLS | |
130 | &ols_driver_info, | |
131 | #endif | |
132 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE | |
133 | &zeroplus_logic_cube_driver_info, | |
134 | #endif | |
135 | #ifdef HAVE_LA_ASIX_SIGMA | |
136 | &asix_sigma_driver_info, | |
137 | #endif | |
138 | #ifdef HAVE_LA_CHRONOVU_LA8 | |
139 | &chronovu_la8_driver_info, | |
140 | #endif | |
141 | #ifdef HAVE_LA_LINK_MSO19 | |
142 | &link_mso19_driver_info, | |
143 | #endif | |
144 | #ifdef HAVE_LA_ALSA | |
145 | &alsa_driver_info, | |
146 | #endif | |
147 | #ifdef HAVE_LA_FX2LAFW | |
148 | &fx2lafw_driver_info, | |
149 | #endif | |
150 | #ifdef HAVE_HW_HANTEK_DSO | |
151 | &hantek_dso_driver_info, | |
152 | #endif | |
153 | #ifdef HAVE_HW_GENERICDMM | |
154 | &genericdmm_driver_info, | |
155 | #endif | |
156 | #ifdef HAVE_HW_AGILENT_DMM | |
157 | &agdmm_driver_info, | |
158 | #endif | |
159 | #ifdef HAVE_HW_FLUKE_DMM | |
160 | &flukedmm_driver_info, | |
161 | #endif | |
162 | #ifdef HAVE_HW_RADIOSHACK_DMM | |
163 | &radioshackdmm_driver_info, | |
164 | #endif | |
165 | #ifdef HAVE_HW_TEKPOWER_DMM | |
166 | &tekpower_dmm_driver_info, | |
167 | #endif | |
168 | #ifdef HAVE_HW_UNI_T_DMM | |
169 | &uni_t_ut61d_driver_info, | |
170 | &voltcraft_vc820_driver_info, | |
171 | #endif | |
172 | NULL, | |
173 | }; | |
174 | ||
175 | /** | |
176 | * Return the list of supported hardware drivers. | |
177 | * | |
178 | * @return Pointer to the NULL-terminated list of hardware driver pointers. | |
179 | */ | |
180 | SR_API struct sr_dev_driver **sr_driver_list(void) | |
181 | { | |
182 | ||
183 | return drivers_list; | |
184 | } | |
185 | ||
186 | /** | |
187 | * Initialize a hardware driver. | |
188 | * | |
189 | * @param driver The driver to initialize. | |
190 | * | |
191 | * @return SR_OK if all went well, or an error code otherwise. | |
192 | */ | |
193 | SR_API int sr_driver_init(struct sr_dev_driver *driver) | |
194 | { | |
195 | ||
196 | if (driver->init) | |
197 | return driver->init(); | |
198 | ||
199 | return SR_OK; | |
200 | } | |
201 | ||
202 | /** | |
203 | * Tell a hardware driver to scan for devices. | |
204 | * | |
205 | * In addition to the detection, the devices that are found are also | |
206 | * initialized automatically. On some devices, this involves a firmware upload, | |
207 | * or other such measures. | |
208 | * | |
209 | * The order in which the system is scanned for devices is not specified. The | |
210 | * caller should not assume or rely on any specific order. | |
211 | * | |
212 | * @param driver The driver. | |
213 | * @param options A list of struct sr_hwopt options to pass to the driver's | |
214 | * scanner. | |
215 | * | |
216 | * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found. | |
217 | * This list must be freed by the caller, but without freeing the data | |
218 | * pointed to in the list. | |
219 | */ | |
220 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
221 | { | |
222 | ||
223 | if (driver->scan) | |
224 | return driver->scan(options); | |
225 | ||
226 | return NULL; | |
227 | } | |
228 | ||
229 | /** @private */ | |
230 | SR_PRIV void sr_hw_cleanup_all(void) | |
231 | { | |
232 | int i; | |
233 | struct sr_dev_driver **drivers; | |
234 | ||
235 | drivers = sr_driver_list(); | |
236 | for (i = 0; drivers[i]; i++) { | |
237 | if (drivers[i]->cleanup) | |
238 | drivers[i]->cleanup(); | |
239 | } | |
240 | } | |
241 | ||
242 | /** | |
243 | * Returns information about the given driver or device instance. | |
244 | * | |
245 | * @param driver The sr_dev_driver struct to query. | |
246 | * @param id The type of information, in the form of an SR_HWCAP_* option. | |
247 | * @param data Pointer where the value. will be stored. Must not be NULL. | |
248 | * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL. | |
249 | * | |
250 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
251 | * may be returned by the driver indicating it doesn't know that id, | |
252 | * but this is not to be flagged as an error by the caller; merely | |
253 | * as an indication that it's not applicable. | |
254 | */ | |
255 | SR_API int sr_info_get(struct sr_dev_driver *driver, int id, | |
256 | const void **data, const struct sr_dev_inst *sdi) | |
257 | { | |
258 | int ret; | |
259 | ||
260 | if (driver == NULL || data == NULL) | |
261 | return SR_ERR; | |
262 | ||
263 | ret = driver->info_get(id, data, sdi); | |
264 | ||
265 | return ret; | |
266 | } | |
267 | ||
268 | /** | |
269 | * Find out if a hardware driver has a specific capability. | |
270 | * | |
271 | * @param driver The hardware driver in which to search for the capability. | |
272 | * @param hwcap The capability to find in the list. | |
273 | * | |
274 | * @return TRUE if the specified capability exists in the specified driver, | |
275 | * FALSE otherwise. Also, if 'driver' is NULL or the respective driver | |
276 | * returns an invalid capability list, FALSE is returned. | |
277 | */ | |
278 | SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) | |
279 | { | |
280 | const int *hwcaps; | |
281 | int i; | |
282 | ||
283 | if (!driver) { | |
284 | sr_err("hwdriver: %s: driver was NULL", __func__); | |
285 | return FALSE; | |
286 | } | |
287 | ||
288 | if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) | |
289 | return FALSE; | |
290 | ||
291 | for (i = 0; hwcaps[i]; i++) { | |
292 | if (hwcaps[i] == hwcap) | |
293 | return TRUE; | |
294 | } | |
295 | ||
296 | return FALSE; | |
297 | } | |
298 | ||
299 | /** | |
300 | * Get information about a hardware driver option. | |
301 | * | |
302 | * @param opt 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_get(int opt) | |
308 | { | |
309 | int i; | |
310 | ||
311 | for (i = 0; sr_drvopts[i].hwcap; i++) { | |
312 | if (sr_drvopts[i].hwcap == opt) | |
313 | return &sr_drvopts[i]; | |
314 | } | |
315 | ||
316 | return NULL; | |
317 | } | |
318 | ||
319 | /** | |
320 | * Get information about a hardware driver option, by name. | |
321 | * | |
322 | * @param optname The name of 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_drvopt_name_get(const char *optname) | |
328 | { | |
329 | int i; | |
330 | ||
331 | for (i = 0; sr_drvopts[i].hwcap; i++) { | |
332 | if (!strcmp(sr_drvopts[i].shortname, optname)) | |
333 | return &sr_drvopts[i]; | |
334 | } | |
335 | ||
336 | return NULL; | |
337 | } | |
338 | ||
339 | /** | |
340 | * Get information about a device option. | |
341 | * | |
342 | * @param opt The option to get. | |
343 | * | |
344 | * @return A pointer to a struct sr_hwcap_option, or NULL if the option | |
345 | * was not found. | |
346 | */ | |
347 | SR_API const struct sr_hwcap_option *sr_devopt_get(int opt) | |
348 | { | |
349 | int i; | |
350 | ||
351 | for (i = 0; sr_devopts[i].hwcap; i++) { | |
352 | if (sr_devopts[i].hwcap == opt) | |
353 | return &sr_devopts[i]; | |
354 | } | |
355 | ||
356 | return NULL; | |
357 | } | |
358 | ||
359 | /** | |
360 | * Get information about a device option, by name. | |
361 | * | |
362 | * @param optname The name of the option to get. | |
363 | * | |
364 | * @return A pointer to a struct sr_hwcap_option, or NULL if the option | |
365 | * was not found. | |
366 | */ | |
367 | SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname) | |
368 | { | |
369 | int i; | |
370 | ||
371 | for (i = 0; sr_devopts[i].hwcap; i++) { | |
372 | if (!strcmp(sr_devopts[i].shortname, optname)) | |
373 | return &sr_devopts[i]; | |
374 | } | |
375 | ||
376 | return NULL; | |
377 | } | |
378 | ||
379 | /* Unnecessary level of indirection follows. */ | |
380 | ||
381 | /** @private */ | |
382 | SR_PRIV int sr_source_remove(int fd) | |
383 | { | |
384 | return sr_session_source_remove(fd); | |
385 | } | |
386 | ||
387 | /** @private */ | |
388 | SR_PRIV int sr_source_add(int fd, int events, int timeout, | |
389 | sr_receive_data_callback_t cb, void *cb_data) | |
390 | { | |
391 | return sr_session_source_add(fd, events, timeout, cb, cb_data); | |
392 | } | |
393 | ||
394 | /** @} */ |