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 <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
  34 SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
  35 static struct sr_dev_driver *di = &victor_dmm_driver_info;
  36 static int hw_dev_close(struct sr_dev_inst *sdi);
  37 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
  38
  39 static const int32_t hwcaps[] = {
  40         SR_CONF_MULTIMETER,
  41         SR_CONF_LIMIT_MSEC,
  42         SR_CONF_LIMIT_SAMPLES,
  43         SR_CONF_CONTINUOUS,
  44 };
  45
  46 /* Properly close and free all devices. */
  47 static int clear_instances(void)
  48 {
  49         struct sr_dev_inst *sdi;
  50         struct drv_context *drvc;
  51         struct dev_context *devc;
  52         GSList *l;
  53
  54         if (!(drvc = di->priv))
  55                 /* Can get called on an unused driver, doesn't matter. */
  56                 return SR_OK;
  57
  58         for (l = drvc->instances; l; l = l->next) {
  59                 if (!(sdi = l->data))
  60                         continue;
  61                 if (!(devc = sdi->priv))
  62                         continue;
  63                 hw_dev_close(sdi);
  64                 sr_usb_dev_inst_free(devc->usb);
  65                 sr_dev_inst_free(sdi);
  66         }
  67
  68         g_slist_free(drvc->instances);
  69         drvc->instances = NULL;
  70
  71         return SR_OK;
  72 }
  73
  74 static int hw_init(struct sr_context *sr_ctx)
  75 {
  76         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
  77 }
  78
  79 static GSList *hw_scan(GSList *options)
  80 {
  81         struct drv_context *drvc;
  82         struct dev_context *devc;
  83         struct sr_dev_inst *sdi;
  84         struct sr_probe *probe;
  85         struct libusb_device_descriptor des;
  86         libusb_device **devlist;
  87         GSList *devices;
  88         int ret, devcnt, i;
  89
  90         (void)options;
  91
  92         drvc = di->priv;
  93
  94         /* USB scan is always authoritative. */
  95         clear_instances();
  96
  97         devices = NULL;
  98         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
  99         for (i = 0; devlist[i]; i++) {
 100                 if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
 101                         sr_warn("Failed to get device descriptor: %s",
 102                                         libusb_error_name(ret));
 103                         continue;
 104                 }
 105
 106                 if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
 107                         continue;
 108
 109                 devcnt = g_slist_length(drvc->instances);
 110                 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
 111                                 VICTOR_VENDOR, NULL, NULL)))
 112                         return NULL;
 113                 sdi->driver = di;
 114
 115                 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
 116                         return NULL;
 117                 sdi->priv = devc;
 118
 119                 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 120                         return NULL;
 121                 sdi->probes = g_slist_append(NULL, probe);
 122
 123                 if (!(devc->usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 124                                 libusb_get_device_address(devlist[i]), NULL)))
 125                         return NULL;
 126
 127                 drvc->instances = g_slist_append(drvc->instances, sdi);
 128                 devices = g_slist_append(devices, sdi);
 129         }
 130         libusb_free_device_list(devlist, 1);
 131
 132         return devices;
 133 }
 134
 135 static GSList *hw_dev_list(void)
 136 {
 137         return ((struct drv_context *)(di->priv))->instances;
 138 }
 139
 140 static int hw_dev_open(struct sr_dev_inst *sdi)
 141 {
 142         struct dev_context *devc;
 143         struct drv_context *drvc = di->priv;
 144         libusb_device **devlist;
 145         int ret, i;
 146
 147         if (!di->priv) {
 148                 sr_err("Driver was not initialized.");
 149                 return SR_ERR;
 150         }
 151
 152         devc = sdi->priv;
 153         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 154         for (i = 0; devlist[i]; i++) {
 155                 if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
 156                                 || libusb_get_device_address(devlist[i]) != devc->usb->address)
 157                         continue;
 158                 if ((ret = libusb_open(devlist[i], &devc->usb->devhdl))) {
 159                         sr_err("Failed to open device: %s.", libusb_error_name(ret));
 160                         return SR_ERR;
 161                 }
 162                 break;
 163         }
 164         libusb_free_device_list(devlist, 1);
 165         if (!devlist[i]) {
 166                 sr_err("Device not found.");
 167                 return SR_ERR;
 168         }
 169
 170         /* The device reports as HID class, so the kernel would have
 171          * claimed it. */
 172         if (libusb_kernel_driver_active(devc->usb->devhdl, 0) == 1) {
 173                 if ((ret = libusb_detach_kernel_driver(devc->usb->devhdl, 0)) < 0) {
 174                         sr_err("Failed to detach kernel driver: %s.",
 175                                libusb_error_name(ret));
 176                         return SR_ERR;
 177                 }
 178         }
 179
 180         if ((ret = libusb_claim_interface(devc->usb->devhdl,
 181                         VICTOR_INTERFACE))) {
 182                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 183                 return SR_ERR;
 184         }
 185         sdi->status = SR_ST_ACTIVE;
 186
 187         return SR_OK;
 188 }
 189
 190 static int hw_dev_close(struct sr_dev_inst *sdi)
 191 {
 192         struct dev_context *devc;
 193
 194         if (!di->priv) {
 195                 sr_err("Driver was not initialized.");
 196                 return SR_ERR;
 197         }
 198
 199         devc = sdi->priv;
 200         if (!devc->usb->devhdl)
 201                 /*  Nothing to do. */
 202                 return SR_OK;
 203
 204         libusb_release_interface(devc->usb->devhdl, VICTOR_INTERFACE);
 205         libusb_close(devc->usb->devhdl);
 206         devc->usb->devhdl = NULL;
 207         sdi->status = SR_ST_INACTIVE;
 208
 209         return SR_OK;
 210 }
 211
 212 static int hw_cleanup(void)
 213 {
 214         struct drv_context *drvc;
 215
 216         if (!(drvc = di->priv))
 217                 /* Can get called on an unused driver, doesn't matter. */
 218                 return SR_OK;
 219
 220         clear_instances();
 221         g_free(drvc);
 222         di->priv = NULL;
 223
 224         return SR_OK;
 225 }
 226
 227 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 228 {
 229         struct dev_context *devc;
 230         gint64 now;
 231         int ret;
 232
 233         if (!di->priv) {
 234                 sr_err("Driver was not initialized.");
 235                 return SR_ERR;
 236         }
 237
 238         if (sdi->status != SR_ST_ACTIVE) {
 239                 sr_err("Device inactive, can't set config options.");
 240                 return SR_ERR;
 241         }
 242
 243         devc = sdi->priv;
 244         ret = SR_OK;
 245         switch (id) {
 246         case SR_CONF_LIMIT_MSEC:
 247                 devc->limit_msec = g_variant_get_uint64(data);
 248                 now = g_get_monotonic_time() / 1000;
 249                 devc->end_time = now + devc->limit_msec;
 250                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 251                        devc->limit_msec);
 252                 break;
 253         case SR_CONF_LIMIT_SAMPLES:
 254                 devc->limit_samples = g_variant_get_uint64(data);
 255                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 256                        devc->limit_samples);
 257                 break;
 258         default:
 259                 sr_err("Unknown hardware capability: %d.", id);
 260                 ret = SR_ERR_ARG;
 261         }
 262
 263         return ret;
 264 }
 265
 266 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 267 {
 268
 269         (void)sdi;
 270
 271         switch (key) {
 272         case SR_CONF_DEVICE_OPTIONS:
 273                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 274                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 275                 break;
 276         default:
 277                 return SR_ERR_ARG;
 278         }
 279
 280         return SR_OK;
 281 }
 282
 283 static void receive_transfer(struct libusb_transfer *transfer)
 284 {
 285         struct dev_context *devc;
 286         struct sr_dev_inst *sdi;
 287         int ret;
 288
 289         sdi = transfer->user_data;
 290         devc = sdi->priv;
 291         if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
 292                 /* USB device was unplugged. */
 293                 hw_dev_acquisition_stop(sdi, sdi);
 294         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
 295                 sr_dbg("Got %d-byte packet.", transfer->actual_length);
 296                 if (transfer->actual_length == DMM_DATA_SIZE) {
 297                         victor_dmm_receive_data(sdi, transfer->buffer);
 298                         if (devc->limit_samples) {
 299                                 if (devc->num_samples >= devc->limit_samples)
 300                                         hw_dev_acquisition_stop(sdi, sdi);
 301                         }
 302                 }
 303         }
 304         /* Anything else is either an error or a timeout, which is fine:
 305          * we were just going to send another transfer request anyway. */
 306
 307         if (sdi->status == SR_ST_ACTIVE) {
 308                 /* Send the same request again. */
 309                 if ((ret = libusb_submit_transfer(transfer) != 0)) {
 310                         sr_err("Unable to resubmit transfer: %s.",
 311                                libusb_error_name(ret));
 312                         g_free(transfer->buffer);
 313                         libusb_free_transfer(transfer);
 314                         hw_dev_acquisition_stop(sdi, sdi);
 315                 }
 316         } else {
 317                 /* This was the last transfer we're going to receive, so
 318                  * clean up now. */
 319                 g_free(transfer->buffer);
 320                 libusb_free_transfer(transfer);
 321         }
 322 }
 323
 324 static int handle_events(int fd, int revents, void *cb_data)
 325 {
 326         struct dev_context *devc;
 327         struct drv_context *drvc = di->priv;
 328         struct sr_datafeed_packet packet;
 329         struct sr_dev_inst *sdi;
 330         struct timeval tv;
 331         gint64 now;
 332         int i;
 333
 334         (void)fd;
 335         (void)revents;
 336
 337         sdi = cb_data;
 338         devc = sdi->priv;
 339
 340         if (devc->limit_msec) {
 341                 now = g_get_monotonic_time() / 1000;
 342                 if (now > devc->end_time)
 343                         hw_dev_acquisition_stop(sdi, sdi);
 344         }
 345
 346         if (sdi->status == SR_ST_STOPPING) {
 347                 for (i = 0; devc->usbfd[i] != -1; i++)
 348                         sr_source_remove(devc->usbfd[i]);
 349
 350                 hw_dev_close(sdi);
 351
 352                 packet.type = SR_DF_END;
 353                 sr_session_send(cb_data, &packet);
 354         }
 355
 356         memset(&tv, 0, sizeof(struct timeval));
 357         libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
 358                                                NULL);
 359
 360         return TRUE;
 361 }
 362
 363 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 364                                     void *cb_data)
 365 {
 366         struct dev_context *devc;
 367         struct drv_context *drvc = di->priv;
 368         const struct libusb_pollfd **pfd;
 369         struct libusb_transfer *transfer;
 370         int ret, i;
 371         unsigned char *buf;
 372
 373         if (!di->priv) {
 374                 sr_err("Driver was not initialized.");
 375                 return SR_ERR;
 376         }
 377
 378         devc = sdi->priv;
 379         devc->cb_data = cb_data;
 380
 381         /* Send header packet to the session bus. */
 382         std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 383
 384         pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 385         for (i = 0; pfd[i]; i++) {
 386                 /* Handle USB events every 100ms, for decent latency. */
 387                 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
 388                                 handle_events, (void *)sdi);
 389                 /* We'll need to remove this fd later. */
 390                 devc->usbfd[i] = pfd[i]->fd;
 391         }
 392         devc->usbfd[i] = -1;
 393
 394         buf = g_try_malloc(DMM_DATA_SIZE);
 395         transfer = libusb_alloc_transfer(0);
 396         /* Each transfer request gets 100ms to arrive before it's restarted.
 397          * The device only sends 1 transfer/second no matter how many
 398          * times you ask, but we want to keep step with the USB events
 399          * handling above. */
 400         libusb_fill_interrupt_transfer(transfer, devc->usb->devhdl,
 401                         VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
 402                         cb_data, 100);
 403         if ((ret = libusb_submit_transfer(transfer) != 0)) {
 404                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 405                 libusb_free_transfer(transfer);
 406                 g_free(buf);
 407                 return SR_ERR;
 408         }
 409
 410         return SR_OK;
 411 }
 412
 413 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 414 {
 415         (void)cb_data;
 416
 417         if (!di->priv) {
 418                 sr_err("Driver was not initialized.");
 419                 return SR_ERR;
 420         }
 421
 422         if (sdi->status != SR_ST_ACTIVE) {
 423                 sr_err("Device not active, can't stop acquisition.");
 424                 return SR_ERR;
 425         }
 426
 427         sdi->status = SR_ST_STOPPING;
 428
 429         return SR_OK;
 430 }
 431
 432 SR_PRIV struct sr_dev_driver victor_dmm_driver_info = {
 433         .name = "victor-dmm",
 434         .longname = "Victor DMMs",
 435         .api_version = 1,
 436         .init = hw_init,
 437         .cleanup = hw_cleanup,
 438         .scan = hw_scan,
 439         .dev_list = hw_dev_list,
 440         .dev_clear = clear_instances,
 441         .config_get = NULL,
 442         .config_set = config_set,
 443         .config_list = config_list,
 444         .dev_open = hw_dev_open,
 445         .dev_close = hw_dev_close,
 446         .dev_acquisition_start = hw_dev_acquisition_start,
 447         .dev_acquisition_stop = hw_dev_acquisition_stop,
 448         .priv = NULL,
 449 };