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