]> sigrok.org Git - libsigrok.git/blame - src/hardware/victor-dmm/api.c
Introduce standard cleanup helper
[libsigrok.git] / src / 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
6ec6c43b 20#include <config.h>
ac3898d2 21#include <glib.h>
7a360375
BV
22#include <libusb.h>
23#include <stdlib.h>
24#include <string.h>
c1aae900 25#include <libsigrok/libsigrok.h>
fa773062
UH
26#include "libsigrok-internal.h"
27#include "protocol.h"
7a360375
BV
28
29#define VICTOR_VID 0x1244
30#define VICTOR_PID 0xd237
31#define VICTOR_VENDOR "Victor"
32#define VICTOR_INTERFACE 0
1a46cc62 33#define VICTOR_ENDPOINT (LIBUSB_ENDPOINT_IN | 1)
ac3898d2
BV
34
35SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
695dc859 36static int dev_acquisition_stop(struct sr_dev_inst *sdi);
7a360375 37
55333928
BV
38static const uint32_t drvopts[] = {
39 SR_CONF_MULTIMETER,
40};
1beccaed 41
a0e0bb41 42static const uint32_t scanopts[] = {
ac046ef8
BV
43 SR_CONF_CONN,
44};
45
f254bc4b 46static const uint32_t devopts[] = {
1953564a 47 SR_CONF_CONTINUOUS,
5827f61b
BV
48 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
49 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
55333928 50 SR_CONF_CONN | SR_CONF_GET,
7a360375
BV
51};
52
4f840ce9 53static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
ac3898d2 54{
f6beaac5 55 return std_init(sr_ctx, di, LOG_PREFIX);
ac3898d2
BV
56}
57
4f840ce9 58static GSList *scan(struct sr_dev_driver *di, GSList *options)
ac3898d2
BV
59{
60 struct drv_context *drvc;
7a360375
BV
61 struct dev_context *devc;
62 struct sr_dev_inst *sdi;
7a360375
BV
63 struct libusb_device_descriptor des;
64 libusb_device **devlist;
ac3898d2 65 GSList *devices;
2a8f2d41 66 int i;
66c91e25 67 char connection_id[64];
ac3898d2
BV
68
69 (void)options;
70
41812aca 71 drvc = di->context;
7a360375 72
ac3898d2 73 devices = NULL;
d4abb463 74 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
7a360375 75 for (i = 0; devlist[i]; i++) {
2a8f2d41 76 libusb_get_device_descriptor(devlist[i], &des);
ac3898d2 77
7a360375
BV
78 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
79 continue;
80
66c91e25
SA
81 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
82
aac29cc1 83 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
84 sdi->status = SR_ST_INACTIVE;
85 sdi->vendor = g_strdup(VICTOR_VENDOR);
7a360375 86 sdi->driver = di;
66c91e25 87 sdi->connection_id = g_strdup(connection_id);
f57d8ffe 88 devc = g_malloc0(sizeof(struct dev_context));
7a360375
BV
89 sdi->priv = devc;
90
5e23fcab 91 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
91219afc
UH
92 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
93 libusb_get_device_address(devlist[i]), NULL);
ac046ef8 94 sdi->inst_type = SR_INST_USB;
7a360375
BV
95
96 drvc->instances = g_slist_append(drvc->instances, sdi);
97 devices = g_slist_append(devices, sdi);
98 }
99 libusb_free_device_list(devlist, 1);
ac3898d2
BV
100
101 return devices;
102}
103
4f840ce9 104static GSList *dev_list(const struct sr_dev_driver *di)
ac3898d2 105{
41812aca 106 return ((struct drv_context *)(di->context))->instances;
ac3898d2
BV
107}
108
6078d2c9 109static int dev_open(struct sr_dev_inst *sdi)
ac3898d2 110{
4f840ce9 111 struct sr_dev_driver *di = sdi->driver;
41812aca 112 struct drv_context *drvc = di->context;
ac046ef8 113 struct sr_usb_dev_inst *usb;
7a360375
BV
114 libusb_device **devlist;
115 int ret, i;
66c91e25 116 char connection_id[64];
7a360375 117
41812aca 118 if (!di->context) {
7a360375
BV
119 sr_err("Driver was not initialized.");
120 return SR_ERR;
121 }
122
ac046ef8
BV
123 usb = sdi->conn;
124
d4abb463 125 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
7a360375 126 for (i = 0; devlist[i]; i++) {
66c91e25
SA
127 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
128 if (strcmp(sdi->connection_id, connection_id))
7a360375 129 continue;
ac046ef8 130 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
fa773062 131 sr_err("Failed to open device: %s.", libusb_error_name(ret));
7a360375
BV
132 return SR_ERR;
133 }
134 break;
135 }
136 libusb_free_device_list(devlist, 1);
137 if (!devlist[i]) {
138 sr_err("Device not found.");
139 return SR_ERR;
140 }
141
142 /* The device reports as HID class, so the kernel would have
143 * claimed it. */
ac046ef8
BV
144 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
145 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
d4928d71
PS
146 sr_err("Failed to detach kernel driver: %s.",
147 libusb_error_name(ret));
7a360375
BV
148 return SR_ERR;
149 }
150 }
151
ac046ef8 152 if ((ret = libusb_claim_interface(usb->devhdl,
7a360375 153 VICTOR_INTERFACE))) {
fa773062 154 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
7a360375
BV
155 return SR_ERR;
156 }
157 sdi->status = SR_ST_ACTIVE;
ac3898d2
BV
158
159 return SR_OK;
160}
161
6078d2c9 162static int dev_close(struct sr_dev_inst *sdi)
ac3898d2 163{
4f840ce9 164 struct sr_dev_driver *di = sdi->driver;
ac046ef8 165 struct sr_usb_dev_inst *usb;
7a360375 166
41812aca 167 if (!di->context) {
7a360375
BV
168 sr_err("Driver was not initialized.");
169 return SR_ERR;
170 }
171
ac046ef8
BV
172 usb = sdi->conn;
173
174 if (!usb->devhdl)
7a360375
BV
175 /* Nothing to do. */
176 return SR_OK;
177
ac046ef8
BV
178 libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
179 libusb_close(usb->devhdl);
180 usb->devhdl = NULL;
7a360375 181 sdi->status = SR_ST_INACTIVE;
ac3898d2
BV
182
183 return SR_OK;
184}
185
584560f1 186static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 187 const struct sr_channel_group *cg)
ac046ef8
BV
188{
189 struct sr_usb_dev_inst *usb;
190 char str[128];
191
53b4680f 192 (void)cg;
8f996b89 193
584560f1 194 switch (key) {
ac046ef8
BV
195 case SR_CONF_CONN:
196 if (!sdi || !sdi->conn)
197 return SR_ERR_ARG;
198 usb = sdi->conn;
199 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
200 *data = g_variant_new_string(str);
201 break;
202 default:
203 return SR_ERR_NA;
204 }
205
206 return SR_OK;
207}
208
584560f1 209static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 210 const struct sr_channel_group *cg)
ac3898d2 211{
4f840ce9 212 struct sr_dev_driver *di = sdi->driver;
7a360375
BV
213 struct dev_context *devc;
214 gint64 now;
ac3898d2 215
53b4680f 216 (void)cg;
8f996b89 217
e73ffd42
BV
218 if (sdi->status != SR_ST_ACTIVE)
219 return SR_ERR_DEV_CLOSED;
220
41812aca 221 if (!di->context) {
7a360375
BV
222 sr_err("Driver was not initialized.");
223 return SR_ERR;
224 }
225
7a360375 226 devc = sdi->priv;
dcd438ee 227
584560f1 228 switch (key) {
1953564a 229 case SR_CONF_LIMIT_MSEC:
a59b4eef 230 devc->limit_msec = g_variant_get_uint64(data);
fa773062
UH
231 now = g_get_monotonic_time() / 1000;
232 devc->end_time = now + devc->limit_msec;
fa773062 233 break;
1953564a 234 case SR_CONF_LIMIT_SAMPLES:
a59b4eef 235 devc->limit_samples = g_variant_get_uint64(data);
fa773062 236 break;
ac3898d2 237 default:
dcd438ee 238 return SR_ERR_NA;
ac3898d2
BV
239 }
240
dcd438ee 241 return SR_OK;
ac3898d2
BV
242}
243
584560f1 244static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 245 const struct sr_channel_group *cg)
a1c743fc 246{
a1c743fc 247 (void)sdi;
53b4680f 248 (void)cg;
a1c743fc
BV
249
250 switch (key) {
ac046ef8 251 case SR_CONF_SCAN_OPTIONS:
584560f1 252 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 253 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
ac046ef8 254 break;
9a6517d1 255 case SR_CONF_DEVICE_OPTIONS:
55333928
BV
256 if (!sdi)
257 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
258 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
259 else
260 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
261 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1 262 break;
a1c743fc 263 default:
bd6fbf62 264 return SR_ERR_NA;
a1c743fc
BV
265 }
266
267 return SR_OK;
268}
269
55462b8b 270static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
7a360375
BV
271{
272 struct dev_context *devc;
273 struct sr_dev_inst *sdi;
274 int ret;
275
276 sdi = transfer->user_data;
277 devc = sdi->priv;
278 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
279 /* USB device was unplugged. */
695dc859 280 dev_acquisition_stop(sdi);
7a360375 281 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
fa773062 282 sr_dbg("Got %d-byte packet.", transfer->actual_length);
ff945683
BV
283 if (transfer->actual_length == DMM_DATA_SIZE) {
284 victor_dmm_receive_data(sdi, transfer->buffer);
7a360375
BV
285 if (devc->limit_samples) {
286 if (devc->num_samples >= devc->limit_samples)
695dc859 287 dev_acquisition_stop(sdi);
7a360375
BV
288 }
289 }
290 }
291 /* Anything else is either an error or a timeout, which is fine:
292 * we were just going to send another transfer request anyway. */
293
294 if (sdi->status == SR_ST_ACTIVE) {
295 /* Send the same request again. */
296 if ((ret = libusb_submit_transfer(transfer) != 0)) {
fa773062
UH
297 sr_err("Unable to resubmit transfer: %s.",
298 libusb_error_name(ret));
7a360375 299 g_free(transfer->buffer);
9ec7ff94 300 libusb_free_transfer(transfer);
695dc859 301 dev_acquisition_stop(sdi);
7a360375
BV
302 }
303 } else {
304 /* This was the last transfer we're going to receive, so
305 * clean up now. */
7a360375 306 g_free(transfer->buffer);
9ec7ff94 307 libusb_free_transfer(transfer);
7a360375 308 }
7a360375
BV
309}
310
311static int handle_events(int fd, int revents, void *cb_data)
312{
313 struct dev_context *devc;
4f840ce9 314 struct drv_context *drvc;
7a360375 315 struct sr_dev_inst *sdi;
4f840ce9 316 struct sr_dev_driver *di;
7a360375
BV
317 struct timeval tv;
318 gint64 now;
7a360375
BV
319
320 (void)fd;
321 (void)revents;
322
323 sdi = cb_data;
324 devc = sdi->priv;
4f840ce9 325 di = sdi->driver;
41812aca 326 drvc = di->context;
7a360375
BV
327
328 if (devc->limit_msec) {
329 now = g_get_monotonic_time() / 1000;
330 if (now > devc->end_time)
695dc859 331 dev_acquisition_stop(sdi);
7a360375
BV
332 }
333
334 if (sdi->status == SR_ST_STOPPING) {
102f1239 335 usb_source_remove(sdi->session, drvc->sr_ctx);
6078d2c9 336 dev_close(sdi);
3be42bc2 337 std_session_send_df_end(sdi, LOG_PREFIX);
7a360375
BV
338 }
339
340 memset(&tv, 0, sizeof(struct timeval));
d4abb463
PS
341 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
342 NULL);
7a360375
BV
343
344 return TRUE;
345}
346
695dc859 347static int dev_acquisition_start(const struct sr_dev_inst *sdi)
ac3898d2 348{
4f840ce9 349 struct sr_dev_driver *di = sdi->driver;
41812aca 350 struct drv_context *drvc = di->context;
ac046ef8 351 struct sr_usb_dev_inst *usb;
7a360375 352 struct libusb_transfer *transfer;
6c60facc 353 int ret;
7a360375
BV
354 unsigned char *buf;
355
e73ffd42
BV
356 if (sdi->status != SR_ST_ACTIVE)
357 return SR_ERR_DEV_CLOSED;
358
41812aca 359 if (!di->context) {
7a360375
BV
360 sr_err("Driver was not initialized.");
361 return SR_ERR;
362 }
363
ac046ef8 364 usb = sdi->conn;
7a360375 365
695dc859 366 std_session_send_df_header(sdi, LOG_PREFIX);
7a360375 367
102f1239
BV
368 usb_source_add(sdi->session, drvc->sr_ctx, 100,
369 handle_events, (void *)sdi);
7a360375 370
a95f142e 371 buf = g_malloc(DMM_DATA_SIZE);
7a360375
BV
372 transfer = libusb_alloc_transfer(0);
373 /* Each transfer request gets 100ms to arrive before it's restarted.
374 * The device only sends 1 transfer/second no matter how many
375 * times you ask, but we want to keep step with the USB events
376 * handling above. */
ac046ef8 377 libusb_fill_interrupt_transfer(transfer, usb->devhdl,
fa773062 378 VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
695dc859 379 (struct sr_dev_inst *)sdi, 100);
7a360375 380 if ((ret = libusb_submit_transfer(transfer) != 0)) {
fa773062 381 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
7a360375
BV
382 libusb_free_transfer(transfer);
383 g_free(buf);
384 return SR_ERR;
385 }
ac3898d2
BV
386
387 return SR_OK;
388}
389
695dc859 390static int dev_acquisition_stop(struct sr_dev_inst *sdi)
ac3898d2 391{
4f840ce9 392 struct sr_dev_driver *di = sdi->driver;
ac3898d2 393
41812aca 394 if (!di->context) {
7a360375
BV
395 sr_err("Driver was not initialized.");
396 return SR_ERR;
397 }
398
ac3898d2 399 if (sdi->status != SR_ST_ACTIVE) {
7a360375 400 sr_err("Device not active, can't stop acquisition.");
ac3898d2
BV
401 return SR_ERR;
402 }
403
7a360375 404 sdi->status = SR_ST_STOPPING;
ac3898d2
BV
405
406 return SR_OK;
407}
408
409SR_PRIV struct sr_dev_driver victor_dmm_driver_info = {
410 .name = "victor-dmm",
7a360375 411 .longname = "Victor DMMs",
ac3898d2 412 .api_version = 1,
6078d2c9 413 .init = init,
700d6b64 414 .cleanup = std_cleanup,
6078d2c9
UH
415 .scan = scan,
416 .dev_list = dev_list,
a6630742 417 .dev_clear = NULL,
ac046ef8 418 .config_get = config_get,
035a1078 419 .config_set = config_set,
a1c743fc 420 .config_list = config_list,
6078d2c9
UH
421 .dev_open = dev_open,
422 .dev_close = dev_close,
423 .dev_acquisition_start = dev_acquisition_start,
424 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 425 .context = NULL,
ac3898d2 426};