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/>.
25 #include <libsigrok/libsigrok.h>
26 #include "libsigrok-internal.h"
29 #define VICTOR_VID 0x1244
30 #define VICTOR_PID 0xd237
31 #define VICTOR_VENDOR "Victor"
32 #define VICTOR_INTERFACE 0
33 #define VICTOR_ENDPOINT (LIBUSB_ENDPOINT_IN | 1)
35 SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
36 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
38 static const uint32_t drvopts[] = {
42 static const uint32_t scanopts[] = {
46 static const uint32_t devopts[] = {
48 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
49 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
50 SR_CONF_CONN | SR_CONF_GET,
53 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
55 return std_init(sr_ctx, di, LOG_PREFIX);
58 static GSList *scan(struct sr_dev_driver *di, GSList *options)
60 struct drv_context *drvc;
61 struct dev_context *devc;
62 struct sr_dev_inst *sdi;
63 struct libusb_device_descriptor des;
64 libusb_device **devlist;
67 char connection_id[64];
74 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
75 for (i = 0; devlist[i]; i++) {
76 libusb_get_device_descriptor(devlist[i], &des);
78 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
81 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
83 sdi = g_malloc0(sizeof(struct sr_dev_inst));
84 sdi->status = SR_ST_INACTIVE;
85 sdi->vendor = g_strdup(VICTOR_VENDOR);
87 sdi->connection_id = g_strdup(connection_id);
88 devc = g_malloc0(sizeof(struct dev_context));
91 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
92 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
93 libusb_get_device_address(devlist[i]), NULL);
94 sdi->inst_type = SR_INST_USB;
96 drvc->instances = g_slist_append(drvc->instances, sdi);
97 devices = g_slist_append(devices, sdi);
99 libusb_free_device_list(devlist, 1);
104 static GSList *dev_list(const struct sr_dev_driver *di)
106 return ((struct drv_context *)(di->context))->instances;
109 static int dev_open(struct sr_dev_inst *sdi)
111 struct sr_dev_driver *di = sdi->driver;
112 struct drv_context *drvc = di->context;
113 struct sr_usb_dev_inst *usb;
114 libusb_device **devlist;
116 char connection_id[64];
119 sr_err("Driver was not initialized.");
125 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
126 for (i = 0; devlist[i]; i++) {
127 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
128 if (strcmp(sdi->connection_id, connection_id))
130 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
131 sr_err("Failed to open device: %s.", libusb_error_name(ret));
136 libusb_free_device_list(devlist, 1);
138 sr_err("Device not found.");
142 /* The device reports as HID class, so the kernel would have
144 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
145 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
146 sr_err("Failed to detach kernel driver: %s.",
147 libusb_error_name(ret));
152 if ((ret = libusb_claim_interface(usb->devhdl,
153 VICTOR_INTERFACE))) {
154 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
157 sdi->status = SR_ST_ACTIVE;
162 static int dev_close(struct sr_dev_inst *sdi)
164 struct sr_dev_driver *di = sdi->driver;
165 struct sr_usb_dev_inst *usb;
168 sr_err("Driver was not initialized.");
178 libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
179 libusb_close(usb->devhdl);
181 sdi->status = SR_ST_INACTIVE;
186 static int cleanup(const struct sr_dev_driver *di)
189 struct drv_context *drvc;
191 if (!(drvc = di->context))
192 /* Can get called on an unused driver, doesn't matter. */
195 ret = std_dev_clear(di, NULL);
201 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
202 const struct sr_channel_group *cg)
204 struct sr_usb_dev_inst *usb;
211 if (!sdi || !sdi->conn)
214 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
215 *data = g_variant_new_string(str);
224 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
225 const struct sr_channel_group *cg)
227 struct sr_dev_driver *di = sdi->driver;
228 struct dev_context *devc;
233 if (sdi->status != SR_ST_ACTIVE)
234 return SR_ERR_DEV_CLOSED;
237 sr_err("Driver was not initialized.");
244 case SR_CONF_LIMIT_MSEC:
245 devc->limit_msec = g_variant_get_uint64(data);
246 now = g_get_monotonic_time() / 1000;
247 devc->end_time = now + devc->limit_msec;
249 case SR_CONF_LIMIT_SAMPLES:
250 devc->limit_samples = g_variant_get_uint64(data);
259 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
260 const struct sr_channel_group *cg)
266 case SR_CONF_SCAN_OPTIONS:
267 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
268 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
270 case SR_CONF_DEVICE_OPTIONS:
272 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
273 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
275 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
276 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
285 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
287 struct dev_context *devc;
288 struct sr_dev_inst *sdi;
291 sdi = transfer->user_data;
293 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
294 /* USB device was unplugged. */
295 dev_acquisition_stop(sdi, sdi);
296 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
297 sr_dbg("Got %d-byte packet.", transfer->actual_length);
298 if (transfer->actual_length == DMM_DATA_SIZE) {
299 victor_dmm_receive_data(sdi, transfer->buffer);
300 if (devc->limit_samples) {
301 if (devc->num_samples >= devc->limit_samples)
302 dev_acquisition_stop(sdi, sdi);
306 /* Anything else is either an error or a timeout, which is fine:
307 * we were just going to send another transfer request anyway. */
309 if (sdi->status == SR_ST_ACTIVE) {
310 /* Send the same request again. */
311 if ((ret = libusb_submit_transfer(transfer) != 0)) {
312 sr_err("Unable to resubmit transfer: %s.",
313 libusb_error_name(ret));
314 g_free(transfer->buffer);
315 libusb_free_transfer(transfer);
316 dev_acquisition_stop(sdi, sdi);
319 /* This was the last transfer we're going to receive, so
321 g_free(transfer->buffer);
322 libusb_free_transfer(transfer);
326 static int handle_events(int fd, int revents, void *cb_data)
328 struct dev_context *devc;
329 struct drv_context *drvc;
330 struct sr_datafeed_packet packet;
331 struct sr_dev_inst *sdi;
332 struct sr_dev_driver *di;
344 if (devc->limit_msec) {
345 now = g_get_monotonic_time() / 1000;
346 if (now > devc->end_time)
347 dev_acquisition_stop(sdi, sdi);
350 if (sdi->status == SR_ST_STOPPING) {
351 usb_source_remove(sdi->session, drvc->sr_ctx);
355 packet.type = SR_DF_END;
356 sr_session_send(cb_data, &packet);
359 memset(&tv, 0, sizeof(struct timeval));
360 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
366 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
368 struct sr_dev_driver *di = sdi->driver;
369 struct dev_context *devc;
370 struct drv_context *drvc = di->context;
371 struct sr_usb_dev_inst *usb;
372 struct libusb_transfer *transfer;
376 if (sdi->status != SR_ST_ACTIVE)
377 return SR_ERR_DEV_CLOSED;
380 sr_err("Driver was not initialized.");
386 devc->cb_data = cb_data;
388 /* Send header packet to the session bus. */
389 std_session_send_df_header(cb_data, LOG_PREFIX);
391 usb_source_add(sdi->session, drvc->sr_ctx, 100,
392 handle_events, (void *)sdi);
394 buf = g_malloc(DMM_DATA_SIZE);
395 transfer = libusb_alloc_transfer(0);
396 /* Each transfer request gets 100ms to arrive before it's restarted.
397 * The device only sends 1 transfer/second no matter how many
398 * times you ask, but we want to keep step with the USB events
400 libusb_fill_interrupt_transfer(transfer, usb->devhdl,
401 VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
403 if ((ret = libusb_submit_transfer(transfer) != 0)) {
404 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
405 libusb_free_transfer(transfer);
413 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
415 struct sr_dev_driver *di = sdi->driver;
419 sr_err("Driver was not initialized.");
423 if (sdi->status != SR_ST_ACTIVE) {
424 sr_err("Device not active, can't stop acquisition.");
428 sdi->status = SR_ST_STOPPING;
433 SR_PRIV struct sr_dev_driver victor_dmm_driver_info = {
434 .name = "victor-dmm",
435 .longname = "Victor DMMs",
440 .dev_list = dev_list,
442 .config_get = config_get,
443 .config_set = config_set,
444 .config_list = config_list,
445 .dev_open = dev_open,
446 .dev_close = dev_close,
447 .dev_acquisition_start = dev_acquisition_start,
448 .dev_acquisition_stop = dev_acquisition_stop,