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