]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/victor-dmm/api.c
Constify a few arrays and variables.
[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 <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
34SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
35static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
36
37static const uint32_t drvopts[] = {
38 SR_CONF_MULTIMETER,
39};
40
41static const uint32_t scanopts[] = {
42 SR_CONF_CONN,
43};
44
45static const uint32_t devopts[] = {
46 SR_CONF_CONTINUOUS,
47 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
48 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
49 SR_CONF_CONN | SR_CONF_GET,
50};
51
52static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
53{
54 return std_init(sr_ctx, di, LOG_PREFIX);
55}
56
57static GSList *scan(struct sr_dev_driver *di, GSList *options)
58{
59 struct drv_context *drvc;
60 struct dev_context *devc;
61 struct sr_dev_inst *sdi;
62 struct libusb_device_descriptor des;
63 libusb_device **devlist;
64 GSList *devices;
65 int ret, i;
66 char connection_id[64];
67
68 (void)options;
69
70 drvc = di->priv;
71
72 devices = NULL;
73 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
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 }
80
81 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
82 continue;
83
84 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
85
86 sdi = g_malloc0(sizeof(struct sr_dev_inst));
87 sdi->status = SR_ST_INACTIVE;
88 sdi->vendor = g_strdup(VICTOR_VENDOR);
89 sdi->driver = di;
90 sdi->connection_id = g_strdup(connection_id);
91 devc = g_malloc0(sizeof(struct dev_context));
92 sdi->priv = devc;
93
94 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
95
96 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
97 libusb_get_device_address(devlist[i]), NULL);
98 sdi->inst_type = SR_INST_USB;
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);
104
105 return devices;
106}
107
108static GSList *dev_list(const struct sr_dev_driver *di)
109{
110 return ((struct drv_context *)(di->priv))->instances;
111}
112
113static int dev_open(struct sr_dev_inst *sdi)
114{
115 struct sr_dev_driver *di = sdi->driver;
116 struct drv_context *drvc = di->priv;
117 struct sr_usb_dev_inst *usb;
118 libusb_device **devlist;
119 int ret, i;
120 char connection_id[64];
121
122 if (!di->priv) {
123 sr_err("Driver was not initialized.");
124 return SR_ERR;
125 }
126
127 usb = sdi->conn;
128
129 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
130 for (i = 0; devlist[i]; i++) {
131 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
132 if (strcmp(sdi->connection_id, connection_id))
133 continue;
134 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
135 sr_err("Failed to open device: %s.", libusb_error_name(ret));
136 return SR_ERR;
137 }
138 break;
139 }
140 libusb_free_device_list(devlist, 1);
141 if (!devlist[i]) {
142 sr_err("Device not found.");
143 return SR_ERR;
144 }
145
146 /* The device reports as HID class, so the kernel would have
147 * claimed it. */
148 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
149 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
150 sr_err("Failed to detach kernel driver: %s.",
151 libusb_error_name(ret));
152 return SR_ERR;
153 }
154 }
155
156 if ((ret = libusb_claim_interface(usb->devhdl,
157 VICTOR_INTERFACE))) {
158 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
159 return SR_ERR;
160 }
161 sdi->status = SR_ST_ACTIVE;
162
163 return SR_OK;
164}
165
166static int dev_close(struct sr_dev_inst *sdi)
167{
168 struct sr_dev_driver *di = sdi->driver;
169 struct sr_usb_dev_inst *usb;
170
171 if (!di->priv) {
172 sr_err("Driver was not initialized.");
173 return SR_ERR;
174 }
175
176 usb = sdi->conn;
177
178 if (!usb->devhdl)
179 /* Nothing to do. */
180 return SR_OK;
181
182 libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
183 libusb_close(usb->devhdl);
184 usb->devhdl = NULL;
185 sdi->status = SR_ST_INACTIVE;
186
187 return SR_OK;
188}
189
190static int cleanup(const struct sr_dev_driver *di)
191{
192 int ret;
193 struct drv_context *drvc;
194
195 if (!(drvc = di->priv))
196 /* Can get called on an unused driver, doesn't matter. */
197 return SR_OK;
198
199 ret = std_dev_clear(di, NULL);
200 g_free(drvc);
201
202 return ret;
203}
204
205static 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
228static 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
268static 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
294static 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
335static 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
375static 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
422static 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
442SR_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};