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