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