]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/victor-dmm/api.c
Drop unneeded std_session_send_df_header() comments.
[libsigrok.git] / src / hardware / victor-dmm / api.c
... / ...
CommitLineData
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 <config.h>
21#include <glib.h>
22#include <libusb.h>
23#include <stdlib.h>
24#include <string.h>
25#include <libsigrok/libsigrok.h>
26#include "libsigrok-internal.h"
27#include "protocol.h"
28
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)
34
35SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
36static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
37
38static const uint32_t drvopts[] = {
39 SR_CONF_MULTIMETER,
40};
41
42static const uint32_t scanopts[] = {
43 SR_CONF_CONN,
44};
45
46static const uint32_t devopts[] = {
47 SR_CONF_CONTINUOUS,
48 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
49 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
50 SR_CONF_CONN | SR_CONF_GET,
51};
52
53static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
54{
55 return std_init(sr_ctx, di, LOG_PREFIX);
56}
57
58static GSList *scan(struct sr_dev_driver *di, GSList *options)
59{
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;
65 GSList *devices;
66 int i;
67 char connection_id[64];
68
69 (void)options;
70
71 drvc = di->context;
72
73 devices = NULL;
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);
77
78 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
79 continue;
80
81 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
82
83 sdi = g_malloc0(sizeof(struct sr_dev_inst));
84 sdi->status = SR_ST_INACTIVE;
85 sdi->vendor = g_strdup(VICTOR_VENDOR);
86 sdi->driver = di;
87 sdi->connection_id = g_strdup(connection_id);
88 devc = g_malloc0(sizeof(struct dev_context));
89 sdi->priv = devc;
90
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;
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);
100
101 return devices;
102}
103
104static GSList *dev_list(const struct sr_dev_driver *di)
105{
106 return ((struct drv_context *)(di->context))->instances;
107}
108
109static int dev_open(struct sr_dev_inst *sdi)
110{
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;
115 int ret, i;
116 char connection_id[64];
117
118 if (!di->context) {
119 sr_err("Driver was not initialized.");
120 return SR_ERR;
121 }
122
123 usb = sdi->conn;
124
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))
129 continue;
130 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
131 sr_err("Failed to open device: %s.", libusb_error_name(ret));
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. */
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));
148 return SR_ERR;
149 }
150 }
151
152 if ((ret = libusb_claim_interface(usb->devhdl,
153 VICTOR_INTERFACE))) {
154 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
155 return SR_ERR;
156 }
157 sdi->status = SR_ST_ACTIVE;
158
159 return SR_OK;
160}
161
162static int dev_close(struct sr_dev_inst *sdi)
163{
164 struct sr_dev_driver *di = sdi->driver;
165 struct sr_usb_dev_inst *usb;
166
167 if (!di->context) {
168 sr_err("Driver was not initialized.");
169 return SR_ERR;
170 }
171
172 usb = sdi->conn;
173
174 if (!usb->devhdl)
175 /* Nothing to do. */
176 return SR_OK;
177
178 libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
179 libusb_close(usb->devhdl);
180 usb->devhdl = NULL;
181 sdi->status = SR_ST_INACTIVE;
182
183 return SR_OK;
184}
185
186static int cleanup(const struct sr_dev_driver *di)
187{
188 int ret;
189 struct drv_context *drvc;
190
191 if (!(drvc = di->context))
192 /* Can get called on an unused driver, doesn't matter. */
193 return SR_OK;
194
195 ret = std_dev_clear(di, NULL);
196 g_free(drvc);
197
198 return ret;
199}
200
201static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
202 const struct sr_channel_group *cg)
203{
204 struct sr_usb_dev_inst *usb;
205 char str[128];
206
207 (void)cg;
208
209 switch (key) {
210 case SR_CONF_CONN:
211 if (!sdi || !sdi->conn)
212 return SR_ERR_ARG;
213 usb = sdi->conn;
214 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
215 *data = g_variant_new_string(str);
216 break;
217 default:
218 return SR_ERR_NA;
219 }
220
221 return SR_OK;
222}
223
224static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
225 const struct sr_channel_group *cg)
226{
227 struct sr_dev_driver *di = sdi->driver;
228 struct dev_context *devc;
229 gint64 now;
230
231 (void)cg;
232
233 if (sdi->status != SR_ST_ACTIVE)
234 return SR_ERR_DEV_CLOSED;
235
236 if (!di->context) {
237 sr_err("Driver was not initialized.");
238 return SR_ERR;
239 }
240
241 devc = sdi->priv;
242
243 switch (key) {
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;
248 break;
249 case SR_CONF_LIMIT_SAMPLES:
250 devc->limit_samples = g_variant_get_uint64(data);
251 break;
252 default:
253 return SR_ERR_NA;
254 }
255
256 return SR_OK;
257}
258
259static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
260 const struct sr_channel_group *cg)
261{
262 (void)sdi;
263 (void)cg;
264
265 switch (key) {
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));
269 break;
270 case SR_CONF_DEVICE_OPTIONS:
271 if (!sdi)
272 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
273 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
274 else
275 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
276 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
277 break;
278 default:
279 return SR_ERR_NA;
280 }
281
282 return SR_OK;
283}
284
285static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
286{
287 struct dev_context *devc;
288 struct sr_dev_inst *sdi;
289 int ret;
290
291 sdi = transfer->user_data;
292 devc = sdi->priv;
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);
303 }
304 }
305 }
306 /* Anything else is either an error or a timeout, which is fine:
307 * we were just going to send another transfer request anyway. */
308
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);
317 }
318 } else {
319 /* This was the last transfer we're going to receive, so
320 * clean up now. */
321 g_free(transfer->buffer);
322 libusb_free_transfer(transfer);
323 }
324}
325
326static int handle_events(int fd, int revents, void *cb_data)
327{
328 struct dev_context *devc;
329 struct drv_context *drvc;
330 struct sr_dev_inst *sdi;
331 struct sr_dev_driver *di;
332 struct timeval tv;
333 gint64 now;
334
335 (void)fd;
336 (void)revents;
337
338 sdi = cb_data;
339 devc = sdi->priv;
340 di = sdi->driver;
341 drvc = di->context;
342
343 if (devc->limit_msec) {
344 now = g_get_monotonic_time() / 1000;
345 if (now > devc->end_time)
346 dev_acquisition_stop(sdi, sdi);
347 }
348
349 if (sdi->status == SR_ST_STOPPING) {
350 usb_source_remove(sdi->session, drvc->sr_ctx);
351 dev_close(sdi);
352 std_session_send_df_end(sdi, LOG_PREFIX);
353 }
354
355 memset(&tv, 0, sizeof(struct timeval));
356 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
357 NULL);
358
359 return TRUE;
360}
361
362static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
363{
364 struct sr_dev_driver *di = sdi->driver;
365 struct dev_context *devc;
366 struct drv_context *drvc = di->context;
367 struct sr_usb_dev_inst *usb;
368 struct libusb_transfer *transfer;
369 int ret;
370 unsigned char *buf;
371
372 if (sdi->status != SR_ST_ACTIVE)
373 return SR_ERR_DEV_CLOSED;
374
375 if (!di->context) {
376 sr_err("Driver was not initialized.");
377 return SR_ERR;
378 }
379
380 devc = sdi->priv;
381 usb = sdi->conn;
382 devc->cb_data = cb_data;
383
384 std_session_send_df_header(cb_data, LOG_PREFIX);
385
386 usb_source_add(sdi->session, drvc->sr_ctx, 100,
387 handle_events, (void *)sdi);
388
389 buf = g_malloc(DMM_DATA_SIZE);
390 transfer = libusb_alloc_transfer(0);
391 /* Each transfer request gets 100ms to arrive before it's restarted.
392 * The device only sends 1 transfer/second no matter how many
393 * times you ask, but we want to keep step with the USB events
394 * handling above. */
395 libusb_fill_interrupt_transfer(transfer, usb->devhdl,
396 VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
397 cb_data, 100);
398 if ((ret = libusb_submit_transfer(transfer) != 0)) {
399 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
400 libusb_free_transfer(transfer);
401 g_free(buf);
402 return SR_ERR;
403 }
404
405 return SR_OK;
406}
407
408static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
409{
410 struct sr_dev_driver *di = sdi->driver;
411 (void)cb_data;
412
413 if (!di->context) {
414 sr_err("Driver was not initialized.");
415 return SR_ERR;
416 }
417
418 if (sdi->status != SR_ST_ACTIVE) {
419 sr_err("Device not active, can't stop acquisition.");
420 return SR_ERR;
421 }
422
423 sdi->status = SR_ST_STOPPING;
424
425 return SR_OK;
426}
427
428SR_PRIV struct sr_dev_driver victor_dmm_driver_info = {
429 .name = "victor-dmm",
430 .longname = "Victor DMMs",
431 .api_version = 1,
432 .init = init,
433 .cleanup = cleanup,
434 .scan = scan,
435 .dev_list = dev_list,
436 .dev_clear = NULL,
437 .config_get = config_get,
438 .config_set = config_set,
439 .config_list = config_list,
440 .dev_open = dev_open,
441 .dev_close = dev_close,
442 .dev_acquisition_start = dev_acquisition_start,
443 .dev_acquisition_stop = dev_acquisition_stop,
444 .context = NULL,
445};