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 static const uint32_t drvopts[] = {
  36         SR_CONF_MULTIMETER,
  37 };
  38
  39 static const uint32_t scanopts[] = {
  40         SR_CONF_CONN,
  41 };
  42
  43 static const uint32_t devopts[] = {
  44         SR_CONF_CONTINUOUS,
  45         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  46         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  47         SR_CONF_CONN | SR_CONF_GET,
  48 };
  49
  50 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  51 {
  52         struct drv_context *drvc;
  53         struct dev_context *devc;
  54         struct sr_dev_inst *sdi;
  55         struct libusb_device_descriptor des;
  56         libusb_device **devlist;
  57         GSList *devices;
  58         int i;
  59         char connection_id[64];
  60
  61         (void)options;
  62
  63         drvc = di->context;
  64
  65         devices = NULL;
  66         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
  67         for (i = 0; devlist[i]; i++) {
  68                 libusb_get_device_descriptor(devlist[i], &des);
  69
  70                 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
  71                         continue;
  72
  73                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
  74
  75                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
  76                 sdi->status = SR_ST_INACTIVE;
  77                 sdi->vendor = g_strdup(VICTOR_VENDOR);
  78                 sdi->connection_id = g_strdup(connection_id);
  79                 devc = g_malloc0(sizeof(struct dev_context));
  80                 sr_sw_limits_init(&devc->limits);
  81                 sdi->priv = devc;
  82
  83                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
  84                 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
  85                                 libusb_get_device_address(devlist[i]), NULL);
  86                 sdi->inst_type = SR_INST_USB;
  87
  88                 devices = g_slist_append(devices, sdi);
  89         }
  90         libusb_free_device_list(devlist, 1);
  91
  92         return std_scan_complete(di, devices);
  93 }
  94
  95 static int dev_open(struct sr_dev_inst *sdi)
  96 {
  97         struct sr_dev_driver *di = sdi->driver;
  98         struct drv_context *drvc = di->context;
  99         struct sr_usb_dev_inst *usb;
 100         int ret;
 101
 102         usb = sdi->conn;
 103
 104         ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
 105         if (ret != SR_OK)
 106                 return ret;
 107
 108         /* The device reports as HID class, so the kernel would have
 109          * claimed it. */
 110         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 111                 if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
 112                         sr_err("Failed to detach kernel driver: %s.",
 113                                libusb_error_name(ret));
 114                         return SR_ERR;
 115                 }
 116         }
 117
 118         if ((ret = libusb_claim_interface(usb->devhdl,
 119                         VICTOR_INTERFACE))) {
 120                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 121                 return SR_ERR;
 122         }
 123
 124         return SR_OK;
 125 }
 126
 127 static int dev_close(struct sr_dev_inst *sdi)
 128 {
 129         struct sr_usb_dev_inst *usb;
 130
 131         usb = sdi->conn;
 132
 133         if (!usb->devhdl)
 134                 /* Nothing to do. */
 135                 return SR_OK;
 136
 137         libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
 138         libusb_close(usb->devhdl);
 139         usb->devhdl = NULL;
 140         sdi->status = SR_ST_INACTIVE;
 141
 142         return SR_OK;
 143 }
 144
 145 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 146                 const struct sr_channel_group *cg)
 147 {
 148         struct dev_context *devc = sdi->priv;
 149         struct sr_usb_dev_inst *usb;
 150         char str[128];
 151
 152         (void)cg;
 153
 154         switch (key) {
 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;
 162         case SR_CONF_LIMIT_SAMPLES:
 163         case SR_CONF_LIMIT_MSEC:
 164                 return sr_sw_limits_config_get(&devc->limits, key, data);
 165         default:
 166                 return SR_ERR_NA;
 167         }
 168
 169         return SR_OK;
 170 }
 171
 172 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 173                 const struct sr_channel_group *cg)
 174 {
 175         struct dev_context *devc;
 176
 177         (void)cg;
 178
 179         devc = sdi->priv;
 180
 181         return sr_sw_limits_config_set(&devc->limits, key, data);
 182 }
 183
 184 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 185                 const struct sr_channel_group *cg)
 186 {
 187         (void)sdi;
 188         (void)cg;
 189
 190         switch (key) {
 191         case SR_CONF_SCAN_OPTIONS:
 192                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 193                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 194                 break;
 195         case SR_CONF_DEVICE_OPTIONS:
 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));
 202                 break;
 203         default:
 204                 return SR_ERR_NA;
 205         }
 206
 207         return SR_OK;
 208 }
 209
 210 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
 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. */
 220                 sr_dev_acquisition_stop(sdi);
 221         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
 222                 sr_dbg("Got %d-byte packet.", transfer->actual_length);
 223                 if (transfer->actual_length == DMM_DATA_SIZE) {
 224                         victor_dmm_receive_data(sdi, transfer->buffer);
 225                         if (sr_sw_limits_check(&devc->limits))
 226                                 sr_dev_acquisition_stop(sdi);
 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)) {
 235                         sr_err("Unable to resubmit transfer: %s.",
 236                                libusb_error_name(ret));
 237                         g_free(transfer->buffer);
 238                         libusb_free_transfer(transfer);
 239                         sr_dev_acquisition_stop(sdi);
 240                 }
 241         } else {
 242                 /* This was the last transfer we're going to receive, so
 243                  * clean up now. */
 244                 g_free(transfer->buffer);
 245                 libusb_free_transfer(transfer);
 246         }
 247 }
 248
 249 static int handle_events(int fd, int revents, void *cb_data)
 250 {
 251         struct dev_context *devc;
 252         struct drv_context *drvc;
 253         struct sr_dev_inst *sdi;
 254         struct sr_dev_driver *di;
 255         struct timeval tv;
 256
 257         (void)fd;
 258         (void)revents;
 259
 260         sdi = cb_data;
 261         devc = sdi->priv;
 262         di = sdi->driver;
 263         drvc = di->context;
 264
 265         if (sr_sw_limits_check(&devc->limits))
 266                 sr_dev_acquisition_stop(sdi);
 267
 268         if (sdi->status == SR_ST_STOPPING) {
 269                 usb_source_remove(sdi->session, drvc->sr_ctx);
 270                 dev_close(sdi);
 271                 std_session_send_df_end(sdi);
 272         }
 273
 274         memset(&tv, 0, sizeof(struct timeval));
 275         libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
 276                                                NULL);
 277
 278         return TRUE;
 279 }
 280
 281 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 282 {
 283         struct sr_dev_driver *di = sdi->driver;
 284         struct drv_context *drvc = di->context;
 285         struct sr_usb_dev_inst *usb;
 286         struct libusb_transfer *transfer;
 287         int ret;
 288         unsigned char *buf;
 289
 290         usb = sdi->conn;
 291
 292         std_session_send_df_header(sdi);
 293
 294         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 295                         handle_events, (void *)sdi);
 296
 297         buf = g_malloc(DMM_DATA_SIZE);
 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. */
 303         libusb_fill_interrupt_transfer(transfer, usb->devhdl,
 304                         VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
 305                         (struct sr_dev_inst *)sdi, 100);
 306         if ((ret = libusb_submit_transfer(transfer) != 0)) {
 307                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 308                 libusb_free_transfer(transfer);
 309                 g_free(buf);
 310                 return SR_ERR;
 311         }
 312
 313         return SR_OK;
 314 }
 315
 316 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 317 {
 318         sdi->status = SR_ST_STOPPING;
 319
 320         return SR_OK;
 321 }
 322
 323 static struct sr_dev_driver victor_dmm_driver_info = {
 324         .name = "victor-dmm",
 325         .longname = "Victor DMMs",
 326         .api_version = 1,
 327         .init = std_init,
 328         .cleanup = std_cleanup,
 329         .scan = scan,
 330         .dev_list = std_dev_list,
 331         .dev_clear = NULL,
 332         .config_get = config_get,
 333         .config_set = config_set,
 334         .config_list = config_list,
 335         .dev_open = dev_open,
 336         .dev_close = dev_close,
 337         .dev_acquisition_start = dev_acquisition_start,
 338         .dev_acquisition_stop = dev_acquisition_stop,
 339         .context = NULL,
 340 };
 341 SR_REGISTER_DEV_DRIVER(victor_dmm_driver_info);