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