src/hardware/victor-dmm/api.c

   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
  35 SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
  36 static int dev_acquisition_stop(struct sr_dev_inst *sdi);
  37
  38 static const uint32_t drvopts[] = {
  39         SR_CONF_MULTIMETER,
  40 };
  41
  42 static const uint32_t scanopts[] = {
  43         SR_CONF_CONN,
  44 };
  45
  46 static 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
  53 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  54 {
  55         return std_init(sr_ctx, di, LOG_PREFIX);
  56 }
  57
  58 static 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
 104 static int dev_open(struct sr_dev_inst *sdi)
 105 {
 106         struct sr_dev_driver *di = sdi->driver;
 107         struct drv_context *drvc = di->context;
 108         struct sr_usb_dev_inst *usb;
 109         libusb_device **devlist;
 110         int ret, i;
 111         char connection_id[64];
 112
 113         usb = sdi->conn;
 114
 115         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 116         for (i = 0; devlist[i]; i++) {
 117                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 118                 if (strcmp(sdi->connection_id, connection_id))
 119                         continue;
 120                 if ((ret = libusb_open(devlist[i], &usb->devhdl))) {
 121                         sr_err("Failed to open device: %s.", libusb_error_name(ret));
 122                         return SR_ERR;
 123                 }
 124                 break;
 125         }
 126         libusb_free_device_list(devlist, 1);
 127         if (!devlist[i]) {
 128                 sr_err("Device not found.");
 129                 return SR_ERR;
 130         }
 131
 132         /* The device reports as HID class, so the kernel would have
 133          * claimed it. */
 134         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 135                 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
 136                         sr_err("Failed to detach kernel driver: %s.",
 137                                libusb_error_name(ret));
 138                         return SR_ERR;
 139                 }
 140         }
 141
 142         if ((ret = libusb_claim_interface(usb->devhdl,
 143                         VICTOR_INTERFACE))) {
 144                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 145                 return SR_ERR;
 146         }
 147         sdi->status = SR_ST_ACTIVE;
 148
 149         return SR_OK;
 150 }
 151
 152 static int dev_close(struct sr_dev_inst *sdi)
 153 {
 154         struct sr_usb_dev_inst *usb;
 155
 156         usb = sdi->conn;
 157
 158         if (!usb->devhdl)
 159                 /*  Nothing to do. */
 160                 return SR_OK;
 161
 162         libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
 163         libusb_close(usb->devhdl);
 164         usb->devhdl = NULL;
 165         sdi->status = SR_ST_INACTIVE;
 166
 167         return SR_OK;
 168 }
 169
 170 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 171                 const struct sr_channel_group *cg)
 172 {
 173         struct sr_usb_dev_inst *usb;
 174         char str[128];
 175
 176         (void)cg;
 177
 178         switch (key) {
 179         case SR_CONF_CONN:
 180                 if (!sdi || !sdi->conn)
 181                         return SR_ERR_ARG;
 182                 usb = sdi->conn;
 183                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 184                 *data = g_variant_new_string(str);
 185                 break;
 186         default:
 187                 return SR_ERR_NA;
 188         }
 189
 190         return SR_OK;
 191 }
 192
 193 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 194                 const struct sr_channel_group *cg)
 195 {
 196         struct dev_context *devc;
 197         gint64 now;
 198
 199         (void)cg;
 200
 201         if (sdi->status != SR_ST_ACTIVE)
 202                 return SR_ERR_DEV_CLOSED;
 203
 204         devc = sdi->priv;
 205
 206         switch (key) {
 207         case SR_CONF_LIMIT_MSEC:
 208                 devc->limit_msec = g_variant_get_uint64(data);
 209                 now = g_get_monotonic_time() / 1000;
 210                 devc->end_time = now + devc->limit_msec;
 211                 break;
 212         case SR_CONF_LIMIT_SAMPLES:
 213                 devc->limit_samples = g_variant_get_uint64(data);
 214                 break;
 215         default:
 216                 return SR_ERR_NA;
 217         }
 218
 219         return SR_OK;
 220 }
 221
 222 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 223                 const struct sr_channel_group *cg)
 224 {
 225         (void)sdi;
 226         (void)cg;
 227
 228         switch (key) {
 229         case SR_CONF_SCAN_OPTIONS:
 230                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 231                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 232                 break;
 233         case SR_CONF_DEVICE_OPTIONS:
 234                 if (!sdi)
 235                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 236                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 237                 else
 238                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 239                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 240                 break;
 241         default:
 242                 return SR_ERR_NA;
 243         }
 244
 245         return SR_OK;
 246 }
 247
 248 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
 249 {
 250         struct dev_context *devc;
 251         struct sr_dev_inst *sdi;
 252         int ret;
 253
 254         sdi = transfer->user_data;
 255         devc = sdi->priv;
 256         if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
 257                 /* USB device was unplugged. */
 258                 dev_acquisition_stop(sdi);
 259         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
 260                 sr_dbg("Got %d-byte packet.", transfer->actual_length);
 261                 if (transfer->actual_length == DMM_DATA_SIZE) {
 262                         victor_dmm_receive_data(sdi, transfer->buffer);
 263                         if (devc->limit_samples) {
 264                                 if (devc->num_samples >= devc->limit_samples)
 265                                         dev_acquisition_stop(sdi);
 266                         }
 267                 }
 268         }
 269         /* Anything else is either an error or a timeout, which is fine:
 270          * we were just going to send another transfer request anyway. */
 271
 272         if (sdi->status == SR_ST_ACTIVE) {
 273                 /* Send the same request again. */
 274                 if ((ret = libusb_submit_transfer(transfer) != 0)) {
 275                         sr_err("Unable to resubmit transfer: %s.",
 276                                libusb_error_name(ret));
 277                         g_free(transfer->buffer);
 278                         libusb_free_transfer(transfer);
 279                         dev_acquisition_stop(sdi);
 280                 }
 281         } else {
 282                 /* This was the last transfer we're going to receive, so
 283                  * clean up now. */
 284                 g_free(transfer->buffer);
 285                 libusb_free_transfer(transfer);
 286         }
 287 }
 288
 289 static int handle_events(int fd, int revents, void *cb_data)
 290 {
 291         struct dev_context *devc;
 292         struct drv_context *drvc;
 293         struct sr_dev_inst *sdi;
 294         struct sr_dev_driver *di;
 295         struct timeval tv;
 296         gint64 now;
 297
 298         (void)fd;
 299         (void)revents;
 300
 301         sdi = cb_data;
 302         devc = sdi->priv;
 303         di = sdi->driver;
 304         drvc = di->context;
 305
 306         if (devc->limit_msec) {
 307                 now = g_get_monotonic_time() / 1000;
 308                 if (now > devc->end_time)
 309                         dev_acquisition_stop(sdi);
 310         }
 311
 312         if (sdi->status == SR_ST_STOPPING) {
 313                 usb_source_remove(sdi->session, drvc->sr_ctx);
 314                 dev_close(sdi);
 315                 std_session_send_df_end(sdi, LOG_PREFIX);
 316         }
 317
 318         memset(&tv, 0, sizeof(struct timeval));
 319         libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
 320                                                NULL);
 321
 322         return TRUE;
 323 }
 324
 325 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 326 {
 327         struct sr_dev_driver *di = sdi->driver;
 328         struct drv_context *drvc = di->context;
 329         struct sr_usb_dev_inst *usb;
 330         struct libusb_transfer *transfer;
 331         int ret;
 332         unsigned char *buf;
 333
 334         if (sdi->status != SR_ST_ACTIVE)
 335                 return SR_ERR_DEV_CLOSED;
 336
 337         usb = sdi->conn;
 338
 339         std_session_send_df_header(sdi, LOG_PREFIX);
 340
 341         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 342                         handle_events, (void *)sdi);
 343
 344         buf = g_malloc(DMM_DATA_SIZE);
 345         transfer = libusb_alloc_transfer(0);
 346         /* Each transfer request gets 100ms to arrive before it's restarted.
 347          * The device only sends 1 transfer/second no matter how many
 348          * times you ask, but we want to keep step with the USB events
 349          * handling above. */
 350         libusb_fill_interrupt_transfer(transfer, usb->devhdl,
 351                         VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
 352                         (struct sr_dev_inst *)sdi, 100);
 353         if ((ret = libusb_submit_transfer(transfer) != 0)) {
 354                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 355                 libusb_free_transfer(transfer);
 356                 g_free(buf);
 357                 return SR_ERR;
 358         }
 359
 360         return SR_OK;
 361 }
 362
 363 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 364 {
 365         if (sdi->status != SR_ST_ACTIVE) {
 366                 sr_err("Device not active, can't stop acquisition.");
 367                 return SR_ERR;
 368         }
 369
 370         sdi->status = SR_ST_STOPPING;
 371
 372         return SR_OK;
 373 }
 374
 375 SR_PRIV struct sr_dev_driver victor_dmm_driver_info = {
 376         .name = "victor-dmm",
 377         .longname = "Victor DMMs",
 378         .api_version = 1,
 379         .init = init,
 380         .cleanup = std_cleanup,
 381         .scan = scan,
 382         .dev_list = std_dev_list,
 383         .dev_clear = NULL,
 384         .config_get = config_get,
 385         .config_set = config_set,
 386         .config_list = config_list,
 387         .dev_open = dev_open,
 388         .dev_close = dev_close,
 389         .dev_acquisition_start = dev_acquisition_start,
 390         .dev_acquisition_stop = dev_acquisition_stop,
 391         .context = NULL,
 392 };