2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
24 #include "libsigrok.h"
25 #include "libsigrok-internal.h"
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
34 SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
35 static struct sr_dev_driver *di = &victor_dmm_driver_info;
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);
39 static const int hwcaps[] = {
42 SR_HWCAP_LIMIT_SAMPLES,
47 static const char *probe_names[] = {
51 /* Properly close and free all devices. */
52 static int clear_instances(void)
54 struct sr_dev_inst *sdi;
55 struct drv_context *drvc;
56 struct dev_context *devc;
59 if (!(drvc = di->priv))
60 /* Can get called on an unused driver, doesn't matter. */
63 for (l = drvc->instances; l; l = l->next) {
66 if (!(devc = sdi->priv))
69 sr_usb_dev_inst_free(devc->usb);
70 sr_dev_inst_free(sdi);
73 g_slist_free(drvc->instances);
74 drvc->instances = NULL;
79 static int hw_init(struct sr_context *sr_ctx)
81 struct drv_context *drvc;
83 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
84 sr_err("Driver context malloc failed.");
92 static GSList *hw_scan(GSList *options)
94 struct drv_context *drvc;
95 struct dev_context *devc;
96 struct sr_dev_inst *sdi;
97 struct sr_probe *probe;
98 struct libusb_device_descriptor des;
99 libusb_device **devlist;
105 if (!(drvc = di->priv)) {
106 sr_err("Driver was not initialized.");
110 /* USB scan is always authoritative. */
114 libusb_get_device_list(NULL, &devlist);
115 for (i = 0; devlist[i]; i++) {
116 if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
117 sr_warn("Failed to get device descriptor: %s",
118 libusb_error_name(ret));
122 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
125 devcnt = g_slist_length(drvc->instances);
126 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
127 VICTOR_VENDOR, NULL, NULL)))
131 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
135 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
137 sdi->probes = g_slist_append(NULL, probe);
139 if (!(devc->usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
140 libusb_get_device_address(devlist[i]), NULL)))
143 drvc->instances = g_slist_append(drvc->instances, sdi);
144 devices = g_slist_append(devices, sdi);
146 libusb_free_device_list(devlist, 1);
151 static GSList *hw_dev_list(void)
153 struct drv_context *drvc;
155 if (!(drvc = di->priv)) {
156 sr_err("Driver was not initialized.");
160 return drvc->instances;
163 static int hw_dev_open(struct sr_dev_inst *sdi)
165 struct dev_context *devc;
166 libusb_device **devlist;
170 sr_err("Driver was not initialized.");
175 libusb_get_device_list(NULL, &devlist);
176 for (i = 0; devlist[i]; i++) {
177 if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
178 || libusb_get_device_address(devlist[i]) != devc->usb->address)
180 if ((ret = libusb_open(devlist[i], &devc->usb->devhdl))) {
181 sr_err("Failed to open device: %s.", libusb_error_name(ret));
186 libusb_free_device_list(devlist, 1);
188 sr_err("Device not found.");
192 /* The device reports as HID class, so the kernel would have
194 if (libusb_kernel_driver_active(devc->usb->devhdl, 0) == 1) {
195 if (libusb_detach_kernel_driver(devc->usb->devhdl, 0) < 0) {
196 sr_err("Failed to detach kernel driver.");
201 if ((ret = libusb_claim_interface(devc->usb->devhdl,
202 VICTOR_INTERFACE))) {
203 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
206 sdi->status = SR_ST_ACTIVE;
211 static int hw_dev_close(struct sr_dev_inst *sdi)
213 struct dev_context *devc;
216 sr_err("Driver was not initialized.");
221 if (!devc->usb->devhdl)
225 libusb_release_interface(devc->usb->devhdl, VICTOR_INTERFACE);
226 libusb_close(devc->usb->devhdl);
227 devc->usb->devhdl = NULL;
228 sdi->status = SR_ST_INACTIVE;
233 static int hw_cleanup(void)
235 struct drv_context *drvc;
237 if (!(drvc = di->priv))
238 /* Can get called on an unused driver, doesn't matter. */
248 static int hw_info_get(int info_id, const void **data,
249 const struct sr_dev_inst *sdi)
257 case SR_DI_NUM_PROBES:
258 *data = GINT_TO_POINTER(1);
260 case SR_DI_PROBE_NAMES:
264 sr_err("Unknown info_id: %d.", info_id);
271 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
274 struct dev_context *devc;
279 sr_err("Driver was not initialized.");
283 if (sdi->status != SR_ST_ACTIVE) {
284 sr_err("Device inactive, can't set config options.");
291 case SR_HWCAP_LIMIT_MSEC:
292 devc->limit_msec = *(const int64_t *)value;
293 now = g_get_monotonic_time() / 1000;
294 devc->end_time = now + devc->limit_msec;
295 sr_dbg("Setting time limit to %" PRIu64 "ms.",
298 case SR_HWCAP_LIMIT_SAMPLES:
299 devc->limit_samples = *(const uint64_t *)value;
300 sr_dbg("Setting sample limit to %" PRIu64 ".",
301 devc->limit_samples);
304 sr_err("Unknown hardware capability: %d.", hwcap);
311 static void receive_transfer(struct libusb_transfer *transfer)
313 struct dev_context *devc;
314 struct sr_dev_inst *sdi;
317 sdi = transfer->user_data;
319 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
320 /* USB device was unplugged. */
321 hw_dev_acquisition_stop(sdi, sdi);
322 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
323 sr_dbg("Got %d-byte packet.", transfer->actual_length);
324 if (transfer->actual_length == DMM_DATA_SIZE) {
325 victor_dmm_receive_data(sdi, transfer->buffer);
326 if (devc->limit_samples) {
327 if (devc->num_samples >= devc->limit_samples)
328 hw_dev_acquisition_stop(sdi, sdi);
332 /* Anything else is either an error or a timeout, which is fine:
333 * we were just going to send another transfer request anyway. */
335 if (sdi->status == SR_ST_ACTIVE) {
336 /* Send the same request again. */
337 if ((ret = libusb_submit_transfer(transfer) != 0)) {
338 sr_err("Unable to resubmit transfer: %s.",
339 libusb_error_name(ret));
340 libusb_free_transfer(transfer);
341 g_free(transfer->buffer);
342 hw_dev_acquisition_stop(sdi, sdi);
345 /* This was the last transfer we're going to receive, so
347 libusb_free_transfer(transfer);
348 g_free(transfer->buffer);
352 static int handle_events(int fd, int revents, void *cb_data)
354 struct dev_context *devc;
355 struct sr_datafeed_packet packet;
356 struct sr_dev_inst *sdi;
367 if (devc->limit_msec) {
368 now = g_get_monotonic_time() / 1000;
369 if (now > devc->end_time)
370 hw_dev_acquisition_stop(sdi, sdi);
373 if (sdi->status == SR_ST_STOPPING) {
374 for (i = 0; devc->usbfd[i] != -1; i++)
375 sr_source_remove(devc->usbfd[i]);
379 packet.type = SR_DF_END;
380 sr_session_send(cb_data, &packet);
383 memset(&tv, 0, sizeof(struct timeval));
384 libusb_handle_events_timeout_completed(NULL, &tv, NULL);
389 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
392 struct sr_datafeed_packet packet;
393 struct sr_datafeed_header header;
394 struct sr_datafeed_meta_analog meta;
395 struct dev_context *devc;
396 const struct libusb_pollfd **pfd;
397 struct libusb_transfer *transfer;
402 sr_err("Driver was not initialized.");
406 sr_dbg("Starting acquisition.");
409 devc->cb_data = cb_data;
411 /* Send header packet to the session bus. */
412 sr_dbg("Sending SR_DF_HEADER.");
413 packet.type = SR_DF_HEADER;
414 packet.payload = (uint8_t *)&header;
415 header.feed_version = 1;
416 sr_session_send(devc->cb_data, &packet);
418 /* Send metadata about the SR_DF_ANALOG packets to come. */
419 packet.type = SR_DF_META_ANALOG;
420 packet.payload = &meta;
422 sr_session_send(devc->cb_data, &packet);
424 pfd = libusb_get_pollfds(NULL);
425 for (i = 0; pfd[i]; i++) {
426 /* Handle USB events every 100ms, for decent latency. */
427 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
428 handle_events, (void *)sdi);
429 /* We'll need to remove this fd later. */
430 devc->usbfd[i] = pfd[i]->fd;
434 buf = g_try_malloc(DMM_DATA_SIZE);
435 transfer = libusb_alloc_transfer(0);
436 /* Each transfer request gets 100ms to arrive before it's restarted.
437 * The device only sends 1 transfer/second no matter how many
438 * times you ask, but we want to keep step with the USB events
440 libusb_fill_interrupt_transfer(transfer, devc->usb->devhdl,
441 VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
443 if ((ret = libusb_submit_transfer(transfer) != 0)) {
444 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
445 libusb_free_transfer(transfer);
453 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
458 sr_err("Driver was not initialized.");
462 if (sdi->status != SR_ST_ACTIVE) {
463 sr_err("Device not active, can't stop acquisition.");
467 sdi->status = SR_ST_STOPPING;
472 SR_PRIV struct sr_dev_driver victor_dmm_driver_info = {
473 .name = "victor-dmm",
474 .longname = "Victor DMMs",
477 .cleanup = hw_cleanup,
479 .dev_list = hw_dev_list,
480 .dev_clear = clear_instances,
481 .dev_open = hw_dev_open,
482 .dev_close = hw_dev_close,
483 .info_get = hw_info_get,
484 .dev_config_set = hw_dev_config_set,
485 .dev_acquisition_start = hw_dev_acquisition_start,
486 .dev_acquisition_stop = hw_dev_acquisition_stop,