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