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