]>
Commit | Line | Data |
---|---|---|
ac3898d2 BV |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 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 <glib.h> | |
7a360375 BV |
21 | #include <libusb.h> |
22 | #include <stdlib.h> | |
23 | #include <string.h> | |
fa773062 UH |
24 | #include "libsigrok.h" |
25 | #include "libsigrok-internal.h" | |
26 | #include "protocol.h" | |
7a360375 BV |
27 | |
28 | #define VICTOR_VID 0x1244 | |
29 | #define VICTOR_PID 0xd237 | |
30 | #define VICTOR_VENDOR "Victor" | |
31 | #define VICTOR_INTERFACE 0 | |
32 | #define VICTOR_ENDPOINT LIBUSB_ENDPOINT_IN | 1 | |
ac3898d2 BV |
33 | |
34 | SR_PRIV struct sr_dev_driver victor_dmm_driver_info; | |
35 | static struct sr_dev_driver *di = &victor_dmm_driver_info; | |
7a360375 BV |
36 | static int hw_dev_close(struct sr_dev_inst *sdi); |
37 | static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data); | |
38 | ||
39 | static const int hwcaps[] = { | |
1953564a BV |
40 | SR_CONF_MULTIMETER, |
41 | SR_CONF_LIMIT_MSEC, | |
42 | SR_CONF_LIMIT_SAMPLES, | |
43 | SR_CONF_CONTINUOUS, | |
7a360375 BV |
44 | 0 |
45 | }; | |
46 | ||
ac3898d2 BV |
47 | /* Properly close and free all devices. */ |
48 | static int clear_instances(void) | |
49 | { | |
50 | struct sr_dev_inst *sdi; | |
51 | struct drv_context *drvc; | |
52 | struct dev_context *devc; | |
53 | GSList *l; | |
54 | ||
7a360375 BV |
55 | if (!(drvc = di->priv)) |
56 | /* Can get called on an unused driver, doesn't matter. */ | |
57 | return SR_OK; | |
58 | ||
ac3898d2 BV |
59 | for (l = drvc->instances; l; l = l->next) { |
60 | if (!(sdi = l->data)) | |
61 | continue; | |
62 | if (!(devc = sdi->priv)) | |
63 | continue; | |
7a360375 BV |
64 | hw_dev_close(sdi); |
65 | sr_usb_dev_inst_free(devc->usb); | |
ac3898d2 BV |
66 | sr_dev_inst_free(sdi); |
67 | } | |
68 | ||
69 | g_slist_free(drvc->instances); | |
70 | drvc->instances = NULL; | |
71 | ||
72 | return SR_OK; | |
73 | } | |
74 | ||
34f06b90 | 75 | static int hw_init(struct sr_context *sr_ctx) |
ac3898d2 BV |
76 | { |
77 | struct drv_context *drvc; | |
78 | ||
79 | if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) { | |
80 | sr_err("Driver context malloc failed."); | |
81 | return SR_ERR_MALLOC; | |
82 | } | |
1ebe4b4e | 83 | drvc->sr_ctx = sr_ctx; |
ac3898d2 BV |
84 | di->priv = drvc; |
85 | ||
86 | return SR_OK; | |
87 | } | |
88 | ||
89 | static GSList *hw_scan(GSList *options) | |
90 | { | |
91 | struct drv_context *drvc; | |
7a360375 BV |
92 | struct dev_context *devc; |
93 | struct sr_dev_inst *sdi; | |
94 | struct sr_probe *probe; | |
95 | struct libusb_device_descriptor des; | |
96 | libusb_device **devlist; | |
ac3898d2 | 97 | GSList *devices; |
7a360375 | 98 | int ret, devcnt, i; |
ac3898d2 BV |
99 | |
100 | (void)options; | |
101 | ||
7a360375 BV |
102 | if (!(drvc = di->priv)) { |
103 | sr_err("Driver was not initialized."); | |
104 | return NULL; | |
105 | } | |
106 | ||
107 | /* USB scan is always authoritative. */ | |
108 | clear_instances(); | |
109 | ||
ac3898d2 | 110 | devices = NULL; |
d4abb463 | 111 | libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); |
7a360375 BV |
112 | for (i = 0; devlist[i]; i++) { |
113 | if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) { | |
114 | sr_warn("Failed to get device descriptor: %s", | |
115 | libusb_error_name(ret)); | |
116 | continue; | |
117 | } | |
ac3898d2 | 118 | |
7a360375 BV |
119 | if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID) |
120 | continue; | |
121 | ||
122 | devcnt = g_slist_length(drvc->instances); | |
fa773062 UH |
123 | if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE, |
124 | VICTOR_VENDOR, NULL, NULL))) | |
7a360375 BV |
125 | return NULL; |
126 | sdi->driver = di; | |
127 | ||
128 | if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) | |
129 | return NULL; | |
130 | sdi->priv = devc; | |
131 | ||
132 | if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1"))) | |
133 | return NULL; | |
134 | sdi->probes = g_slist_append(NULL, probe); | |
135 | ||
136 | if (!(devc->usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]), | |
137 | libusb_get_device_address(devlist[i]), NULL))) | |
138 | return NULL; | |
139 | ||
140 | drvc->instances = g_slist_append(drvc->instances, sdi); | |
141 | devices = g_slist_append(devices, sdi); | |
142 | } | |
143 | libusb_free_device_list(devlist, 1); | |
ac3898d2 BV |
144 | |
145 | return devices; | |
146 | } | |
147 | ||
148 | static GSList *hw_dev_list(void) | |
149 | { | |
150 | struct drv_context *drvc; | |
151 | ||
7a360375 BV |
152 | if (!(drvc = di->priv)) { |
153 | sr_err("Driver was not initialized."); | |
154 | return NULL; | |
155 | } | |
ac3898d2 BV |
156 | |
157 | return drvc->instances; | |
158 | } | |
159 | ||
160 | static int hw_dev_open(struct sr_dev_inst *sdi) | |
161 | { | |
7a360375 | 162 | struct dev_context *devc; |
d4abb463 | 163 | struct drv_context *drvc = di->priv; |
7a360375 BV |
164 | libusb_device **devlist; |
165 | int ret, i; | |
166 | ||
167 | if (!di->priv) { | |
168 | sr_err("Driver was not initialized."); | |
169 | return SR_ERR; | |
170 | } | |
171 | ||
172 | devc = sdi->priv; | |
d4abb463 | 173 | libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); |
7a360375 BV |
174 | for (i = 0; devlist[i]; i++) { |
175 | if (libusb_get_bus_number(devlist[i]) != devc->usb->bus | |
176 | || libusb_get_device_address(devlist[i]) != devc->usb->address) | |
177 | continue; | |
178 | if ((ret = libusb_open(devlist[i], &devc->usb->devhdl))) { | |
fa773062 | 179 | sr_err("Failed to open device: %s.", libusb_error_name(ret)); |
7a360375 BV |
180 | return SR_ERR; |
181 | } | |
182 | break; | |
183 | } | |
184 | libusb_free_device_list(devlist, 1); | |
185 | if (!devlist[i]) { | |
186 | sr_err("Device not found."); | |
187 | return SR_ERR; | |
188 | } | |
189 | ||
190 | /* The device reports as HID class, so the kernel would have | |
191 | * claimed it. */ | |
192 | if (libusb_kernel_driver_active(devc->usb->devhdl, 0) == 1) { | |
d4928d71 PS |
193 | if ((ret = libusb_detach_kernel_driver(devc->usb->devhdl, 0)) < 0) { |
194 | sr_err("Failed to detach kernel driver: %s.", | |
195 | libusb_error_name(ret)); | |
7a360375 BV |
196 | return SR_ERR; |
197 | } | |
198 | } | |
199 | ||
200 | if ((ret = libusb_claim_interface(devc->usb->devhdl, | |
201 | VICTOR_INTERFACE))) { | |
fa773062 | 202 | sr_err("Failed to claim interface: %s.", libusb_error_name(ret)); |
7a360375 BV |
203 | return SR_ERR; |
204 | } | |
205 | sdi->status = SR_ST_ACTIVE; | |
ac3898d2 BV |
206 | |
207 | return SR_OK; | |
208 | } | |
209 | ||
210 | static int hw_dev_close(struct sr_dev_inst *sdi) | |
211 | { | |
7a360375 BV |
212 | struct dev_context *devc; |
213 | ||
214 | if (!di->priv) { | |
215 | sr_err("Driver was not initialized."); | |
216 | return SR_ERR; | |
217 | } | |
218 | ||
219 | devc = sdi->priv; | |
220 | if (!devc->usb->devhdl) | |
221 | /* Nothing to do. */ | |
222 | return SR_OK; | |
223 | ||
224 | libusb_release_interface(devc->usb->devhdl, VICTOR_INTERFACE); | |
225 | libusb_close(devc->usb->devhdl); | |
226 | devc->usb->devhdl = NULL; | |
227 | sdi->status = SR_ST_INACTIVE; | |
ac3898d2 BV |
228 | |
229 | return SR_OK; | |
230 | } | |
231 | ||
232 | static int hw_cleanup(void) | |
233 | { | |
7a360375 BV |
234 | struct drv_context *drvc; |
235 | ||
236 | if (!(drvc = di->priv)) | |
237 | /* Can get called on an unused driver, doesn't matter. */ | |
238 | return SR_OK; | |
ac3898d2 | 239 | |
7a360375 BV |
240 | clear_instances(); |
241 | g_free(drvc); | |
242 | di->priv = NULL; | |
ac3898d2 BV |
243 | |
244 | return SR_OK; | |
245 | } | |
246 | ||
035a1078 | 247 | static int config_get(int id, const void **data, const struct sr_dev_inst *sdi) |
ac3898d2 | 248 | { |
7a360375 BV |
249 | (void)sdi; |
250 | ||
035a1078 | 251 | switch (id) { |
fa773062 | 252 | default: |
fa773062 | 253 | return SR_ERR_ARG; |
ac3898d2 BV |
254 | } |
255 | ||
256 | return SR_OK; | |
257 | } | |
258 | ||
035a1078 | 259 | static int config_set(int id, const void *value, const struct sr_dev_inst *sdi) |
ac3898d2 | 260 | { |
7a360375 BV |
261 | struct dev_context *devc; |
262 | gint64 now; | |
ac3898d2 BV |
263 | int ret; |
264 | ||
7a360375 BV |
265 | if (!di->priv) { |
266 | sr_err("Driver was not initialized."); | |
267 | return SR_ERR; | |
268 | } | |
269 | ||
ac3898d2 BV |
270 | if (sdi->status != SR_ST_ACTIVE) { |
271 | sr_err("Device inactive, can't set config options."); | |
272 | return SR_ERR; | |
273 | } | |
274 | ||
7a360375 | 275 | devc = sdi->priv; |
ac3898d2 | 276 | ret = SR_OK; |
035a1078 | 277 | switch (id) { |
1953564a | 278 | case SR_CONF_LIMIT_MSEC: |
fa773062 UH |
279 | devc->limit_msec = *(const int64_t *)value; |
280 | now = g_get_monotonic_time() / 1000; | |
281 | devc->end_time = now + devc->limit_msec; | |
282 | sr_dbg("Setting time limit to %" PRIu64 "ms.", | |
283 | devc->limit_msec); | |
284 | break; | |
1953564a | 285 | case SR_CONF_LIMIT_SAMPLES: |
fa773062 UH |
286 | devc->limit_samples = *(const uint64_t *)value; |
287 | sr_dbg("Setting sample limit to %" PRIu64 ".", | |
288 | devc->limit_samples); | |
289 | break; | |
ac3898d2 | 290 | default: |
035a1078 | 291 | sr_err("Unknown hardware capability: %d.", id); |
ac3898d2 BV |
292 | ret = SR_ERR_ARG; |
293 | } | |
294 | ||
295 | return ret; | |
296 | } | |
297 | ||
a1c743fc BV |
298 | static int config_list(int key, const void **data, const struct sr_dev_inst *sdi) |
299 | { | |
300 | ||
301 | (void)sdi; | |
302 | ||
303 | switch (key) { | |
9a6517d1 BV |
304 | case SR_CONF_DEVICE_OPTIONS: |
305 | *data = hwcaps; | |
306 | break; | |
a1c743fc BV |
307 | default: |
308 | return SR_ERR_ARG; | |
309 | } | |
310 | ||
311 | return SR_OK; | |
312 | } | |
313 | ||
7a360375 BV |
314 | static void receive_transfer(struct libusb_transfer *transfer) |
315 | { | |
316 | struct dev_context *devc; | |
317 | struct sr_dev_inst *sdi; | |
318 | int ret; | |
319 | ||
320 | sdi = transfer->user_data; | |
321 | devc = sdi->priv; | |
322 | if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) { | |
323 | /* USB device was unplugged. */ | |
324 | hw_dev_acquisition_stop(sdi, sdi); | |
325 | } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) { | |
fa773062 | 326 | sr_dbg("Got %d-byte packet.", transfer->actual_length); |
ff945683 BV |
327 | if (transfer->actual_length == DMM_DATA_SIZE) { |
328 | victor_dmm_receive_data(sdi, transfer->buffer); | |
7a360375 BV |
329 | if (devc->limit_samples) { |
330 | if (devc->num_samples >= devc->limit_samples) | |
331 | hw_dev_acquisition_stop(sdi, sdi); | |
332 | } | |
333 | } | |
334 | } | |
335 | /* Anything else is either an error or a timeout, which is fine: | |
336 | * we were just going to send another transfer request anyway. */ | |
337 | ||
338 | if (sdi->status == SR_ST_ACTIVE) { | |
339 | /* Send the same request again. */ | |
340 | if ((ret = libusb_submit_transfer(transfer) != 0)) { | |
fa773062 UH |
341 | sr_err("Unable to resubmit transfer: %s.", |
342 | libusb_error_name(ret)); | |
7a360375 | 343 | g_free(transfer->buffer); |
9ec7ff94 | 344 | libusb_free_transfer(transfer); |
7a360375 BV |
345 | hw_dev_acquisition_stop(sdi, sdi); |
346 | } | |
347 | } else { | |
348 | /* This was the last transfer we're going to receive, so | |
349 | * clean up now. */ | |
7a360375 | 350 | g_free(transfer->buffer); |
9ec7ff94 | 351 | libusb_free_transfer(transfer); |
7a360375 | 352 | } |
7a360375 BV |
353 | } |
354 | ||
355 | static int handle_events(int fd, int revents, void *cb_data) | |
356 | { | |
357 | struct dev_context *devc; | |
d4abb463 | 358 | struct drv_context *drvc = di->priv; |
7a360375 BV |
359 | struct sr_datafeed_packet packet; |
360 | struct sr_dev_inst *sdi; | |
361 | struct timeval tv; | |
362 | gint64 now; | |
363 | int i; | |
364 | ||
365 | (void)fd; | |
366 | (void)revents; | |
367 | ||
368 | sdi = cb_data; | |
369 | devc = sdi->priv; | |
370 | ||
371 | if (devc->limit_msec) { | |
372 | now = g_get_monotonic_time() / 1000; | |
373 | if (now > devc->end_time) | |
374 | hw_dev_acquisition_stop(sdi, sdi); | |
375 | } | |
376 | ||
377 | if (sdi->status == SR_ST_STOPPING) { | |
378 | for (i = 0; devc->usbfd[i] != -1; i++) | |
379 | sr_source_remove(devc->usbfd[i]); | |
380 | ||
381 | hw_dev_close(sdi); | |
382 | ||
383 | packet.type = SR_DF_END; | |
384 | sr_session_send(cb_data, &packet); | |
385 | } | |
386 | ||
387 | memset(&tv, 0, sizeof(struct timeval)); | |
d4abb463 PS |
388 | libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv, |
389 | NULL); | |
7a360375 BV |
390 | |
391 | return TRUE; | |
392 | } | |
393 | ||
ac3898d2 BV |
394 | static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi, |
395 | void *cb_data) | |
396 | { | |
7a360375 BV |
397 | struct sr_datafeed_packet packet; |
398 | struct sr_datafeed_header header; | |
7a360375 | 399 | struct dev_context *devc; |
d4abb463 | 400 | struct drv_context *drvc = di->priv; |
7a360375 BV |
401 | const struct libusb_pollfd **pfd; |
402 | struct libusb_transfer *transfer; | |
403 | int ret, i; | |
404 | unsigned char *buf; | |
405 | ||
406 | if (!di->priv) { | |
407 | sr_err("Driver was not initialized."); | |
408 | return SR_ERR; | |
409 | } | |
410 | ||
411 | sr_dbg("Starting acquisition."); | |
412 | ||
413 | devc = sdi->priv; | |
414 | devc->cb_data = cb_data; | |
415 | ||
416 | /* Send header packet to the session bus. */ | |
417 | sr_dbg("Sending SR_DF_HEADER."); | |
418 | packet.type = SR_DF_HEADER; | |
419 | packet.payload = (uint8_t *)&header; | |
420 | header.feed_version = 1; | |
421 | sr_session_send(devc->cb_data, &packet); | |
422 | ||
d4abb463 | 423 | pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx); |
7a360375 BV |
424 | for (i = 0; pfd[i]; i++) { |
425 | /* Handle USB events every 100ms, for decent latency. */ | |
426 | sr_source_add(pfd[i]->fd, pfd[i]->events, 100, | |
427 | handle_events, (void *)sdi); | |
428 | /* We'll need to remove this fd later. */ | |
429 | devc->usbfd[i] = pfd[i]->fd; | |
430 | } | |
431 | devc->usbfd[i] = -1; | |
432 | ||
ff945683 | 433 | buf = g_try_malloc(DMM_DATA_SIZE); |
7a360375 BV |
434 | transfer = libusb_alloc_transfer(0); |
435 | /* Each transfer request gets 100ms to arrive before it's restarted. | |
436 | * The device only sends 1 transfer/second no matter how many | |
437 | * times you ask, but we want to keep step with the USB events | |
438 | * handling above. */ | |
439 | libusb_fill_interrupt_transfer(transfer, devc->usb->devhdl, | |
fa773062 UH |
440 | VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer, |
441 | cb_data, 100); | |
7a360375 | 442 | if ((ret = libusb_submit_transfer(transfer) != 0)) { |
fa773062 | 443 | sr_err("Unable to submit transfer: %s.", libusb_error_name(ret)); |
7a360375 BV |
444 | libusb_free_transfer(transfer); |
445 | g_free(buf); | |
446 | return SR_ERR; | |
447 | } | |
ac3898d2 BV |
448 | |
449 | return SR_OK; | |
450 | } | |
451 | ||
7a360375 | 452 | static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) |
ac3898d2 BV |
453 | { |
454 | (void)cb_data; | |
455 | ||
7a360375 BV |
456 | if (!di->priv) { |
457 | sr_err("Driver was not initialized."); | |
458 | return SR_ERR; | |
459 | } | |
460 | ||
ac3898d2 | 461 | if (sdi->status != SR_ST_ACTIVE) { |
7a360375 | 462 | sr_err("Device not active, can't stop acquisition."); |
ac3898d2 BV |
463 | return SR_ERR; |
464 | } | |
465 | ||
7a360375 | 466 | sdi->status = SR_ST_STOPPING; |
ac3898d2 BV |
467 | |
468 | return SR_OK; | |
469 | } | |
470 | ||
471 | SR_PRIV struct sr_dev_driver victor_dmm_driver_info = { | |
472 | .name = "victor-dmm", | |
7a360375 | 473 | .longname = "Victor DMMs", |
ac3898d2 BV |
474 | .api_version = 1, |
475 | .init = hw_init, | |
476 | .cleanup = hw_cleanup, | |
477 | .scan = hw_scan, | |
478 | .dev_list = hw_dev_list, | |
479 | .dev_clear = clear_instances, | |
035a1078 BV |
480 | .config_get = config_get, |
481 | .config_set = config_set, | |
a1c743fc | 482 | .config_list = config_list, |
ac3898d2 BV |
483 | .dev_open = hw_dev_open, |
484 | .dev_close = hw_dev_close, | |
ac3898d2 BV |
485 | .dev_acquisition_start = hw_dev_acquisition_start, |
486 | .dev_acquisition_stop = hw_dev_acquisition_stop, | |
487 | .priv = NULL, | |
488 | }; |