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 int32_t hwcaps[] = {
42 SR_CONF_LIMIT_SAMPLES,
46 /* Properly close and free all devices. */
47 static int clear_instances(void)
49 struct sr_dev_inst *sdi;
50 struct drv_context *drvc;
51 struct dev_context *devc;
54 if (!(drvc = di->priv))
55 /* Can get called on an unused driver, doesn't matter. */
58 for (l = drvc->instances; l; l = l->next) {
61 if (!(devc = sdi->priv))
64 sr_usb_dev_inst_free(devc->usb);
65 sr_dev_inst_free(sdi);
68 g_slist_free(drvc->instances);
69 drvc->instances = NULL;
74 static int hw_init(struct sr_context *sr_ctx)
76 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
79 static GSList *hw_scan(GSList *options)
81 struct drv_context *drvc;
82 struct dev_context *devc;
83 struct sr_dev_inst *sdi;
84 struct sr_probe *probe;
85 struct libusb_device_descriptor des;
86 libusb_device **devlist;
94 /* USB scan is always authoritative. */
98 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
99 for (i = 0; devlist[i]; i++) {
100 if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
101 sr_warn("Failed to get device descriptor: %s",
102 libusb_error_name(ret));
106 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
109 devcnt = g_slist_length(drvc->instances);
110 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
111 VICTOR_VENDOR, NULL, NULL)))
115 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
119 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
121 sdi->probes = g_slist_append(NULL, probe);
123 if (!(devc->usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
124 libusb_get_device_address(devlist[i]), NULL)))
127 drvc->instances = g_slist_append(drvc->instances, sdi);
128 devices = g_slist_append(devices, sdi);
130 libusb_free_device_list(devlist, 1);
135 static GSList *hw_dev_list(void)
137 return ((struct drv_context *)(di->priv))->instances;
140 static int hw_dev_open(struct sr_dev_inst *sdi)
142 struct dev_context *devc;
143 struct drv_context *drvc = di->priv;
144 libusb_device **devlist;
148 sr_err("Driver was not initialized.");
153 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
154 for (i = 0; devlist[i]; i++) {
155 if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
156 || libusb_get_device_address(devlist[i]) != devc->usb->address)
158 if ((ret = libusb_open(devlist[i], &devc->usb->devhdl))) {
159 sr_err("Failed to open device: %s.", libusb_error_name(ret));
164 libusb_free_device_list(devlist, 1);
166 sr_err("Device not found.");
170 /* The device reports as HID class, so the kernel would have
172 if (libusb_kernel_driver_active(devc->usb->devhdl, 0) == 1) {
173 if ((ret = libusb_detach_kernel_driver(devc->usb->devhdl, 0)) < 0) {
174 sr_err("Failed to detach kernel driver: %s.",
175 libusb_error_name(ret));
180 if ((ret = libusb_claim_interface(devc->usb->devhdl,
181 VICTOR_INTERFACE))) {
182 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
185 sdi->status = SR_ST_ACTIVE;
190 static int hw_dev_close(struct sr_dev_inst *sdi)
192 struct dev_context *devc;
195 sr_err("Driver was not initialized.");
200 if (!devc->usb->devhdl)
204 libusb_release_interface(devc->usb->devhdl, VICTOR_INTERFACE);
205 libusb_close(devc->usb->devhdl);
206 devc->usb->devhdl = NULL;
207 sdi->status = SR_ST_INACTIVE;
212 static int hw_cleanup(void)
214 struct drv_context *drvc;
216 if (!(drvc = di->priv))
217 /* Can get called on an unused driver, doesn't matter. */
227 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
229 struct dev_context *devc;
234 sr_err("Driver was not initialized.");
238 if (sdi->status != SR_ST_ACTIVE) {
239 sr_err("Device inactive, can't set config options.");
246 case SR_CONF_LIMIT_MSEC:
247 devc->limit_msec = g_variant_get_uint64(data);
248 now = g_get_monotonic_time() / 1000;
249 devc->end_time = now + devc->limit_msec;
250 sr_dbg("Setting time limit to %" PRIu64 "ms.",
253 case SR_CONF_LIMIT_SAMPLES:
254 devc->limit_samples = g_variant_get_uint64(data);
255 sr_dbg("Setting sample limit to %" PRIu64 ".",
256 devc->limit_samples);
265 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
271 case SR_CONF_DEVICE_OPTIONS:
272 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
273 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
282 static void receive_transfer(struct libusb_transfer *transfer)
284 struct dev_context *devc;
285 struct sr_dev_inst *sdi;
288 sdi = transfer->user_data;
290 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
291 /* USB device was unplugged. */
292 hw_dev_acquisition_stop(sdi, sdi);
293 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
294 sr_dbg("Got %d-byte packet.", transfer->actual_length);
295 if (transfer->actual_length == DMM_DATA_SIZE) {
296 victor_dmm_receive_data(sdi, transfer->buffer);
297 if (devc->limit_samples) {
298 if (devc->num_samples >= devc->limit_samples)
299 hw_dev_acquisition_stop(sdi, sdi);
303 /* Anything else is either an error or a timeout, which is fine:
304 * we were just going to send another transfer request anyway. */
306 if (sdi->status == SR_ST_ACTIVE) {
307 /* Send the same request again. */
308 if ((ret = libusb_submit_transfer(transfer) != 0)) {
309 sr_err("Unable to resubmit transfer: %s.",
310 libusb_error_name(ret));
311 g_free(transfer->buffer);
312 libusb_free_transfer(transfer);
313 hw_dev_acquisition_stop(sdi, sdi);
316 /* This was the last transfer we're going to receive, so
318 g_free(transfer->buffer);
319 libusb_free_transfer(transfer);
323 static int handle_events(int fd, int revents, void *cb_data)
325 struct dev_context *devc;
326 struct drv_context *drvc = di->priv;
327 struct sr_datafeed_packet packet;
328 struct sr_dev_inst *sdi;
339 if (devc->limit_msec) {
340 now = g_get_monotonic_time() / 1000;
341 if (now > devc->end_time)
342 hw_dev_acquisition_stop(sdi, sdi);
345 if (sdi->status == SR_ST_STOPPING) {
346 for (i = 0; devc->usbfd[i] != -1; i++)
347 sr_source_remove(devc->usbfd[i]);
351 packet.type = SR_DF_END;
352 sr_session_send(cb_data, &packet);
355 memset(&tv, 0, sizeof(struct timeval));
356 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
362 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
365 struct dev_context *devc;
366 struct drv_context *drvc = di->priv;
367 const struct libusb_pollfd **pfd;
368 struct libusb_transfer *transfer;
373 sr_err("Driver was not initialized.");
378 devc->cb_data = cb_data;
380 /* Send header packet to the session bus. */
381 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
383 pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
384 for (i = 0; pfd[i]; i++) {
385 /* Handle USB events every 100ms, for decent latency. */
386 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
387 handle_events, (void *)sdi);
388 /* We'll need to remove this fd later. */
389 devc->usbfd[i] = pfd[i]->fd;
393 buf = g_try_malloc(DMM_DATA_SIZE);
394 transfer = libusb_alloc_transfer(0);
395 /* Each transfer request gets 100ms to arrive before it's restarted.
396 * The device only sends 1 transfer/second no matter how many
397 * times you ask, but we want to keep step with the USB events
399 libusb_fill_interrupt_transfer(transfer, devc->usb->devhdl,
400 VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
402 if ((ret = libusb_submit_transfer(transfer) != 0)) {
403 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
404 libusb_free_transfer(transfer);
412 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
417 sr_err("Driver was not initialized.");
421 if (sdi->status != SR_ST_ACTIVE) {
422 sr_err("Device not active, can't stop acquisition.");
426 sdi->status = SR_ST_STOPPING;
431 SR_PRIV struct sr_dev_driver victor_dmm_driver_info = {
432 .name = "victor-dmm",
433 .longname = "Victor DMMs",
436 .cleanup = hw_cleanup,
438 .dev_list = hw_dev_list,
439 .dev_clear = clear_instances,
441 .config_set = config_set,
442 .config_list = config_list,
443 .dev_open = hw_dev_open,
444 .dev_close = hw_dev_close,
445 .dev_acquisition_start = hw_dev_acquisition_start,
446 .dev_acquisition_stop = hw_dev_acquisition_stop,