]> sigrok.org Git - libsigrok.git/blame - src/hardware/victor-dmm/api.c
sr_dev_open(): Set status to SR_ST_ACTIVE upon success.
[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)
d9251a2c 34
55333928
BV
35static const uint32_t drvopts[] = {
36 SR_CONF_MULTIMETER,
37};
1beccaed 38
a0e0bb41 39static const uint32_t scanopts[] = {
ac046ef8
BV
40 SR_CONF_CONN,
41};
42
f254bc4b 43static const uint32_t devopts[] = {
1953564a 44 SR_CONF_CONTINUOUS,
5827f61b
BV
45 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
46 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
55333928 47 SR_CONF_CONN | SR_CONF_GET,
7a360375
BV
48};
49
4f840ce9 50static GSList *scan(struct sr_dev_driver *di, GSList *options)
ac3898d2
BV
51{
52 struct drv_context *drvc;
7a360375
BV
53 struct dev_context *devc;
54 struct sr_dev_inst *sdi;
7a360375
BV
55 struct libusb_device_descriptor des;
56 libusb_device **devlist;
ac3898d2 57 GSList *devices;
2a8f2d41 58 int i;
66c91e25 59 char connection_id[64];
ac3898d2
BV
60
61 (void)options;
62
41812aca 63 drvc = di->context;
7a360375 64
ac3898d2 65 devices = NULL;
d4abb463 66 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
7a360375 67 for (i = 0; devlist[i]; i++) {
2a8f2d41 68 libusb_get_device_descriptor(devlist[i], &des);
ac3898d2 69
7a360375
BV
70 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
71 continue;
72
66c91e25
SA
73 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
74
aac29cc1 75 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
76 sdi->status = SR_ST_INACTIVE;
77 sdi->vendor = g_strdup(VICTOR_VENDOR);
66c91e25 78 sdi->connection_id = g_strdup(connection_id);
f57d8ffe 79 devc = g_malloc0(sizeof(struct dev_context));
cf9e86bc 80 sr_sw_limits_init(&devc->limits);
7a360375
BV
81 sdi->priv = devc;
82
5e23fcab 83 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
91219afc
UH
84 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
85 libusb_get_device_address(devlist[i]), NULL);
ac046ef8 86 sdi->inst_type = SR_INST_USB;
7a360375 87
7a360375
BV
88 devices = g_slist_append(devices, sdi);
89 }
90 libusb_free_device_list(devlist, 1);
ac3898d2 91
15a5bfe4 92 return std_scan_complete(di, devices);
ac3898d2
BV
93}
94
6078d2c9 95static int dev_open(struct sr_dev_inst *sdi)
ac3898d2 96{
4f840ce9 97 struct sr_dev_driver *di = sdi->driver;
41812aca 98 struct drv_context *drvc = di->context;
ac046ef8 99 struct sr_usb_dev_inst *usb;
4af1f68f 100 int ret;
7a360375 101
ac046ef8
BV
102 usb = sdi->conn;
103
4af1f68f
LPC
104 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
105 if (ret != SR_OK)
106 return ret;
7a360375
BV
107
108 /* The device reports as HID class, so the kernel would have
109 * claimed it. */
ac046ef8
BV
110 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
111 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
d4928d71
PS
112 sr_err("Failed to detach kernel driver: %s.",
113 libusb_error_name(ret));
7a360375
BV
114 return SR_ERR;
115 }
116 }
117
ac046ef8 118 if ((ret = libusb_claim_interface(usb->devhdl,
7a360375 119 VICTOR_INTERFACE))) {
fa773062 120 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
7a360375
BV
121 return SR_ERR;
122 }
ac3898d2
BV
123
124 return SR_OK;
125}
126
6078d2c9 127static int dev_close(struct sr_dev_inst *sdi)
ac3898d2 128{
ac046ef8 129 struct sr_usb_dev_inst *usb;
7a360375 130
ac046ef8
BV
131 usb = sdi->conn;
132
133 if (!usb->devhdl)
d9251a2c 134 /* Nothing to do. */
7a360375
BV
135 return SR_OK;
136
ac046ef8
BV
137 libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
138 libusb_close(usb->devhdl);
139 usb->devhdl = NULL;
7a360375 140 sdi->status = SR_ST_INACTIVE;
ac3898d2
BV
141
142 return SR_OK;
143}
144
584560f1 145static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 146 const struct sr_channel_group *cg)
ac046ef8 147{
cf9e86bc 148 struct dev_context *devc = sdi->priv;
ac046ef8
BV
149 struct sr_usb_dev_inst *usb;
150 char str[128];
151
53b4680f 152 (void)cg;
8f996b89 153
584560f1 154 switch (key) {
ac046ef8
BV
155 case SR_CONF_CONN:
156 if (!sdi || !sdi->conn)
157 return SR_ERR_ARG;
158 usb = sdi->conn;
159 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
160 *data = g_variant_new_string(str);
161 break;
cf9e86bc
LPC
162 case SR_CONF_LIMIT_SAMPLES:
163 case SR_CONF_LIMIT_MSEC:
164 return sr_sw_limits_config_get(&devc->limits, key, data);
ac046ef8
BV
165 default:
166 return SR_ERR_NA;
167 }
168
169 return SR_OK;
170}
171
584560f1 172static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 173 const struct sr_channel_group *cg)
ac3898d2 174{
7a360375 175 struct dev_context *devc;
ac3898d2 176
53b4680f 177 (void)cg;
8f996b89 178
7a360375 179 devc = sdi->priv;
dcd438ee 180
cf9e86bc 181 return sr_sw_limits_config_set(&devc->limits, key, data);
ac3898d2
BV
182}
183
584560f1 184static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 185 const struct sr_channel_group *cg)
a1c743fc 186{
a1c743fc 187 (void)sdi;
53b4680f 188 (void)cg;
a1c743fc
BV
189
190 switch (key) {
ac046ef8 191 case SR_CONF_SCAN_OPTIONS:
584560f1 192 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 193 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
ac046ef8 194 break;
9a6517d1 195 case SR_CONF_DEVICE_OPTIONS:
55333928
BV
196 if (!sdi)
197 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
198 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
199 else
200 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
201 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1 202 break;
a1c743fc 203 default:
bd6fbf62 204 return SR_ERR_NA;
a1c743fc
BV
205 }
206
207 return SR_OK;
208}
209
55462b8b 210static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
7a360375
BV
211{
212 struct dev_context *devc;
213 struct sr_dev_inst *sdi;
214 int ret;
215
216 sdi = transfer->user_data;
217 devc = sdi->priv;
218 if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
219 /* USB device was unplugged. */
d2f7c417 220 sr_dev_acquisition_stop(sdi);
7a360375 221 } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
fa773062 222 sr_dbg("Got %d-byte packet.", transfer->actual_length);
ff945683
BV
223 if (transfer->actual_length == DMM_DATA_SIZE) {
224 victor_dmm_receive_data(sdi, transfer->buffer);
cf9e86bc 225 if (sr_sw_limits_check(&devc->limits))
d2f7c417 226 sr_dev_acquisition_stop(sdi);
7a360375
BV
227 }
228 }
229 /* Anything else is either an error or a timeout, which is fine:
230 * we were just going to send another transfer request anyway. */
231
232 if (sdi->status == SR_ST_ACTIVE) {
233 /* Send the same request again. */
234 if ((ret = libusb_submit_transfer(transfer) != 0)) {
fa773062
UH
235 sr_err("Unable to resubmit transfer: %s.",
236 libusb_error_name(ret));
7a360375 237 g_free(transfer->buffer);
9ec7ff94 238 libusb_free_transfer(transfer);
d2f7c417 239 sr_dev_acquisition_stop(sdi);
7a360375
BV
240 }
241 } else {
242 /* This was the last transfer we're going to receive, so
243 * clean up now. */
7a360375 244 g_free(transfer->buffer);
9ec7ff94 245 libusb_free_transfer(transfer);
7a360375 246 }
7a360375
BV
247}
248
249static int handle_events(int fd, int revents, void *cb_data)
250{
251 struct dev_context *devc;
4f840ce9 252 struct drv_context *drvc;
7a360375 253 struct sr_dev_inst *sdi;
4f840ce9 254 struct sr_dev_driver *di;
7a360375 255 struct timeval tv;
7a360375
BV
256
257 (void)fd;
258 (void)revents;
259
260 sdi = cb_data;
261 devc = sdi->priv;
4f840ce9 262 di = sdi->driver;
41812aca 263 drvc = di->context;
7a360375 264
cf9e86bc 265 if (sr_sw_limits_check(&devc->limits))
d2f7c417 266 sr_dev_acquisition_stop(sdi);
7a360375
BV
267
268 if (sdi->status == SR_ST_STOPPING) {
102f1239 269 usb_source_remove(sdi->session, drvc->sr_ctx);
6078d2c9 270 dev_close(sdi);
bee2b016 271 std_session_send_df_end(sdi);
7a360375
BV
272 }
273
274 memset(&tv, 0, sizeof(struct timeval));
d4abb463
PS
275 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
276 NULL);
7a360375
BV
277
278 return TRUE;
279}
280
695dc859 281static int dev_acquisition_start(const struct sr_dev_inst *sdi)
ac3898d2 282{
4f840ce9 283 struct sr_dev_driver *di = sdi->driver;
41812aca 284 struct drv_context *drvc = di->context;
ac046ef8 285 struct sr_usb_dev_inst *usb;
7a360375 286 struct libusb_transfer *transfer;
6c60facc 287 int ret;
7a360375
BV
288 unsigned char *buf;
289
ac046ef8 290 usb = sdi->conn;
7a360375 291
bee2b016 292 std_session_send_df_header(sdi);
7a360375 293
102f1239
BV
294 usb_source_add(sdi->session, drvc->sr_ctx, 100,
295 handle_events, (void *)sdi);
7a360375 296
a95f142e 297 buf = g_malloc(DMM_DATA_SIZE);
7a360375
BV
298 transfer = libusb_alloc_transfer(0);
299 /* Each transfer request gets 100ms to arrive before it's restarted.
300 * The device only sends 1 transfer/second no matter how many
301 * times you ask, but we want to keep step with the USB events
302 * handling above. */
ac046ef8 303 libusb_fill_interrupt_transfer(transfer, usb->devhdl,
fa773062 304 VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
695dc859 305 (struct sr_dev_inst *)sdi, 100);
7a360375 306 if ((ret = libusb_submit_transfer(transfer) != 0)) {
fa773062 307 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
7a360375
BV
308 libusb_free_transfer(transfer);
309 g_free(buf);
310 return SR_ERR;
311 }
ac3898d2
BV
312
313 return SR_OK;
314}
315
695dc859 316static int dev_acquisition_stop(struct sr_dev_inst *sdi)
ac3898d2 317{
7a360375 318 sdi->status = SR_ST_STOPPING;
ac3898d2
BV
319
320 return SR_OK;
321}
322
dd5c48a6 323static struct sr_dev_driver victor_dmm_driver_info = {
ac3898d2 324 .name = "victor-dmm",
7a360375 325 .longname = "Victor DMMs",
ac3898d2 326 .api_version = 1,
c2fdcc25 327 .init = std_init,
700d6b64 328 .cleanup = std_cleanup,
6078d2c9 329 .scan = scan,
c01bf34c 330 .dev_list = std_dev_list,
a6630742 331 .dev_clear = NULL,
ac046ef8 332 .config_get = config_get,
035a1078 333 .config_set = config_set,
a1c743fc 334 .config_list = config_list,
6078d2c9
UH
335 .dev_open = dev_open,
336 .dev_close = dev_close,
337 .dev_acquisition_start = dev_acquisition_start,
338 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 339 .context = NULL,
ac3898d2 340};
dd5c48a6 341SR_REGISTER_DEV_DRIVER(victor_dmm_driver_info);