src/hardware/dreamsourcelab-dslogic/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22 #include <math.h>
  23 #include "protocol.h"
  24
  25 static const struct dslogic_profile supported_device[] = {
  26         /* DreamSourceLab DSLogic */
  27         { 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
  28                 "dreamsourcelab-dslogic-fx2.fw",
  29                 0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
  30         /* DreamSourceLab DSCope */
  31         { 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
  32                 "dreamsourcelab-dscope-fx2.fw",
  33                 0, "DreamSourceLab", "DSCope", 256 * 1024 * 1024},
  34         /* DreamSourceLab DSLogic Pro */
  35         { 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
  36                 "dreamsourcelab-dslogic-pro-fx2.fw",
  37                 0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
  38         /* DreamSourceLab DSLogic Plus */
  39         { 0x2a0e, 0x0020, "DreamSourceLab", "DSLogic Plus", NULL,
  40                 "dreamsourcelab-dslogic-plus-fx2.fw",
  41                 0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
  42         /* DreamSourceLab DSLogic Basic */
  43         { 0x2a0e, 0x0021, "DreamSourceLab", "DSLogic Basic", NULL,
  44                 "dreamsourcelab-dslogic-basic-fx2.fw",
  45                 0, "DreamSourceLab", "DSLogic", 256 * 1024},
  46
  47         ALL_ZERO
  48 };
  49
  50 static const uint32_t scanopts[] = {
  51         SR_CONF_CONN,
  52 };
  53
  54 static const uint32_t drvopts[] = {
  55         SR_CONF_LOGIC_ANALYZER,
  56 };
  57
  58 static const uint32_t devopts[] = {
  59         SR_CONF_CONTINUOUS | SR_CONF_SET | SR_CONF_GET,
  60         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  61         SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  62         SR_CONF_CONN | SR_CONF_GET,
  63         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  64         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  65         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
  66         SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
  67         SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  68 };
  69
  70 static const char *const signal_edge_names[] = {
  71         [DS_EDGE_RISING] = "rising",
  72         [DS_EDGE_FALLING] = "falling",
  73 };
  74
  75 static const double voltage_thresholds[][2] = {
  76         { 0.7, 1.4 },
  77         { 1.4, 3.6 },
  78 };
  79
  80 static const uint64_t samplerates[] = {
  81         SR_KHZ(10),
  82         SR_KHZ(20),
  83         SR_KHZ(50),
  84         SR_KHZ(100),
  85         SR_KHZ(200),
  86         SR_KHZ(500),
  87         SR_MHZ(1),
  88         SR_MHZ(2),
  89         SR_MHZ(5),
  90         SR_MHZ(10),
  91         SR_MHZ(20),
  92         SR_MHZ(25),
  93         SR_MHZ(50),
  94         SR_MHZ(100),
  95         SR_MHZ(200),
  96         SR_MHZ(400),
  97 };
  98
  99 static gboolean is_plausible(const struct libusb_device_descriptor *des)
 100 {
 101         int i;
 102
 103         for (i = 0; supported_device[i].vid; i++) {
 104                 if (des->idVendor != supported_device[i].vid)
 105                         continue;
 106                 if (des->idProduct == supported_device[i].pid)
 107                         return TRUE;
 108         }
 109
 110         return FALSE;
 111 }
 112
 113 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 114 {
 115         struct drv_context *drvc;
 116         struct dev_context *devc;
 117         struct sr_dev_inst *sdi;
 118         struct sr_usb_dev_inst *usb;
 119         struct sr_channel *ch;
 120         struct sr_channel_group *cg;
 121         struct sr_config *src;
 122         const struct dslogic_profile *prof;
 123         GSList *l, *devices, *conn_devices;
 124         gboolean has_firmware;
 125         struct libusb_device_descriptor des;
 126         libusb_device **devlist;
 127         struct libusb_device_handle *hdl;
 128         int ret, i, j;
 129         const char *conn;
 130         char manufacturer[64], product[64], serial_num[64], connection_id[64];
 131         char channel_name[16];
 132
 133         drvc = di->context;
 134
 135         conn = NULL;
 136         for (l = options; l; l = l->next) {
 137                 src = l->data;
 138                 switch (src->key) {
 139                 case SR_CONF_CONN:
 140                         conn = g_variant_get_string(src->data, NULL);
 141                         break;
 142                 }
 143         }
 144         if (conn)
 145                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
 146         else
 147                 conn_devices = NULL;
 148
 149         /* Find all DSLogic compatible devices and upload firmware to them. */
 150         devices = NULL;
 151         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 152         for (i = 0; devlist[i]; i++) {
 153                 if (conn) {
 154                         usb = NULL;
 155                         for (l = conn_devices; l; l = l->next) {
 156                                 usb = l->data;
 157                                 if (usb->bus == libusb_get_bus_number(devlist[i])
 158                                         && usb->address == libusb_get_device_address(devlist[i]))
 159                                         break;
 160                         }
 161                         if (!l)
 162                                 /* This device matched none of the ones that
 163                                  * matched the conn specification. */
 164                                 continue;
 165                 }
 166
 167                 libusb_get_device_descriptor(devlist[i], &des);
 168
 169                 if (!is_plausible(&des))
 170                         continue;
 171
 172                 if ((ret = libusb_open(devlist[i], &hdl)) < 0) {
 173                         sr_warn("Failed to open potential device with "
 174                                 "VID:PID %04x:%04x: %s.", des.idVendor,
 175                                 des.idProduct, libusb_error_name(ret));
 176                         continue;
 177                 }
 178
 179                 if (des.iManufacturer == 0) {
 180                         manufacturer[0] = '\0';
 181                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 182                                 des.iManufacturer, (unsigned char *) manufacturer,
 183                                 sizeof(manufacturer))) < 0) {
 184                         sr_warn("Failed to get manufacturer string descriptor: %s.",
 185                                 libusb_error_name(ret));
 186                         continue;
 187                 }
 188
 189                 if (des.iProduct == 0) {
 190                         product[0] = '\0';
 191                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 192                                 des.iProduct, (unsigned char *) product,
 193                                 sizeof(product))) < 0) {
 194                         sr_warn("Failed to get product string descriptor: %s.",
 195                                 libusb_error_name(ret));
 196                         continue;
 197                 }
 198
 199                 if (des.iSerialNumber == 0) {
 200                         serial_num[0] = '\0';
 201                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
 202                                 des.iSerialNumber, (unsigned char *) serial_num,
 203                                 sizeof(serial_num))) < 0) {
 204                         sr_warn("Failed to get serial number string descriptor: %s.",
 205                                 libusb_error_name(ret));
 206                         continue;
 207                 }
 208
 209                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 210
 211                 libusb_close(hdl);
 212
 213                 prof = NULL;
 214                 for (j = 0; supported_device[j].vid; j++) {
 215                         if (des.idVendor == supported_device[j].vid &&
 216                                         des.idProduct == supported_device[j].pid) {
 217                                 prof = &supported_device[j];
 218                                 break;
 219                         }
 220                 }
 221
 222                 if (!prof)
 223                         continue;
 224
 225                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 226                 sdi->status = SR_ST_INITIALIZING;
 227                 sdi->vendor = g_strdup(prof->vendor);
 228                 sdi->model = g_strdup(prof->model);
 229                 sdi->version = g_strdup(prof->model_version);
 230                 sdi->serial_num = g_strdup(serial_num);
 231                 sdi->connection_id = g_strdup(connection_id);
 232
 233                 /* Logic channels, all in one channel group. */
 234                 cg = g_malloc0(sizeof(struct sr_channel_group));
 235                 cg->name = g_strdup("Logic");
 236                 for (j = 0; j < 16; j++) {
 237                         sprintf(channel_name, "%d", j);
 238                         ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
 239                                                 TRUE, channel_name);
 240                         cg->channels = g_slist_append(cg->channels, ch);
 241                 }
 242                 sdi->channel_groups = g_slist_append(NULL, cg);
 243
 244                 devc = dslogic_dev_new();
 245                 devc->profile = prof;
 246                 sdi->priv = devc;
 247                 devices = g_slist_append(devices, sdi);
 248
 249                 devc->samplerates = samplerates;
 250                 devc->num_samplerates = ARRAY_SIZE(samplerates);
 251                 has_firmware = usb_match_manuf_prod(devlist[i], "DreamSourceLab", "USB-based Instrument");
 252
 253                 if (has_firmware) {
 254                         /* Already has the firmware, so fix the new address. */
 255                         sr_dbg("Found a DSLogic device.");
 256                         sdi->status = SR_ST_INACTIVE;
 257                         sdi->inst_type = SR_INST_USB;
 258                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 259                                         libusb_get_device_address(devlist[i]), NULL);
 260                 } else {
 261                         if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
 262                                         USB_CONFIGURATION, prof->firmware) == SR_OK)
 263                                 /* Store when this device's FW was updated. */
 264                                 devc->fw_updated = g_get_monotonic_time();
 265                         else
 266                                 sr_err("Firmware upload failed for "
 267                                        "device %d.%d (logical).",
 268                                        libusb_get_bus_number(devlist[i]),
 269                                        libusb_get_device_address(devlist[i]));
 270                         sdi->inst_type = SR_INST_USB;
 271                         sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
 272                                         0xff, NULL);
 273                 }
 274         }
 275         libusb_free_device_list(devlist, 1);
 276         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 277
 278         return std_scan_complete(di, devices);
 279 }
 280
 281 static int dev_open(struct sr_dev_inst *sdi)
 282 {
 283         struct sr_dev_driver *di = sdi->driver;
 284         struct sr_usb_dev_inst *usb;
 285         struct dev_context *devc;
 286         int ret;
 287         int64_t timediff_us, timediff_ms;
 288
 289         devc = sdi->priv;
 290         usb = sdi->conn;
 291
 292         /*
 293          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 294          * milliseconds for the FX2 to renumerate.
 295          */
 296         ret = SR_ERR;
 297         if (devc->fw_updated > 0) {
 298                 sr_info("Waiting for device to reset.");
 299                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
 300                 g_usleep(300 * 1000);
 301                 timediff_ms = 0;
 302                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 303                         if ((ret = dslogic_dev_open(sdi, di)) == SR_OK)
 304                                 break;
 305                         g_usleep(100 * 1000);
 306
 307                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 308                         timediff_ms = timediff_us / 1000;
 309                         sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
 310                 }
 311                 if (ret != SR_OK) {
 312                         sr_err("Device failed to renumerate.");
 313                         return SR_ERR;
 314                 }
 315                 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
 316         } else {
 317                 sr_info("Firmware upload was not needed.");
 318                 ret = dslogic_dev_open(sdi, di);
 319         }
 320
 321         if (ret != SR_OK) {
 322                 sr_err("Unable to open device.");
 323                 return SR_ERR;
 324         }
 325
 326         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
 327         if (ret != 0) {
 328                 switch (ret) {
 329                 case LIBUSB_ERROR_BUSY:
 330                         sr_err("Unable to claim USB interface. Another "
 331                                "program or driver has already claimed it.");
 332                         break;
 333                 case LIBUSB_ERROR_NO_DEVICE:
 334                         sr_err("Device has been disconnected.");
 335                         break;
 336                 default:
 337                         sr_err("Unable to claim interface: %s.",
 338                                libusb_error_name(ret));
 339                         break;
 340                 }
 341
 342                 return SR_ERR;
 343         }
 344
 345
 346         if ((ret = dslogic_fpga_firmware_upload(sdi)) != SR_OK)
 347                 return ret;
 348
 349         if (devc->cur_samplerate == 0) {
 350                 /* Samplerate hasn't been set; default to the slowest one. */
 351                 devc->cur_samplerate = devc->samplerates[0];
 352         }
 353
 354         if (devc->cur_threshold == 0.0)
 355                 devc->cur_threshold = 1.5;
 356
 357         return SR_OK;
 358 }
 359
 360 static int dev_close(struct sr_dev_inst *sdi)
 361 {
 362         struct sr_usb_dev_inst *usb;
 363
 364         usb = sdi->conn;
 365
 366         if (!usb->devhdl)
 367                 return SR_ERR_BUG;
 368
 369         sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
 370                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
 371         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 372         libusb_close(usb->devhdl);
 373         usb->devhdl = NULL;
 374
 375         return SR_OK;
 376 }
 377
 378 static int config_get(uint32_t key, GVariant **data,
 379         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 380 {
 381         struct dev_context *devc;
 382         struct sr_usb_dev_inst *usb;
 383         unsigned int i, voltage_range;
 384
 385         (void)cg;
 386
 387         if (!sdi)
 388                 return SR_ERR_ARG;
 389
 390         devc = sdi->priv;
 391
 392         switch (key) {
 393         case SR_CONF_CONN:
 394                 if (!sdi->conn)
 395                         return SR_ERR_ARG;
 396                 usb = sdi->conn;
 397                 if (usb->address == 255)
 398                         /* Device still needs to re-enumerate after firmware
 399                          * upload, so we don't know its (future) address. */
 400                         return SR_ERR;
 401                 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
 402                 break;
 403         case SR_CONF_VOLTAGE_THRESHOLD:
 404                 if (!strcmp(devc->profile->model, "DSLogic")) {
 405                         voltage_range = 0;
 406
 407                         for (i = 0; i < ARRAY_SIZE(voltage_thresholds); i++)
 408                                 if (voltage_thresholds[i][0] == devc->cur_threshold) {
 409                                         voltage_range = i;
 410                                         break;
 411                                 }
 412                         *data = std_gvar_tuple_double(voltage_thresholds[voltage_range][0],
 413                                         voltage_thresholds[voltage_range][1]);
 414                 } else {
 415                         *data = std_gvar_tuple_double(devc->cur_threshold, devc->cur_threshold);
 416                 }
 417                 break;
 418         case SR_CONF_LIMIT_SAMPLES:
 419                 *data = g_variant_new_uint64(devc->limit_samples);
 420                 break;
 421         case SR_CONF_SAMPLERATE:
 422                 *data = g_variant_new_uint64(devc->cur_samplerate);
 423                 break;
 424         case SR_CONF_CAPTURE_RATIO:
 425                 *data = g_variant_new_uint64(devc->capture_ratio);
 426                 break;
 427         case SR_CONF_EXTERNAL_CLOCK:
 428                 *data = g_variant_new_boolean(devc->external_clock);
 429                 break;
 430         case SR_CONF_CONTINUOUS:
 431                 *data = g_variant_new_boolean(devc->continuous_mode);
 432                 break;
 433         case SR_CONF_CLOCK_EDGE:
 434                 i = devc->clock_edge;
 435                 if (i >= ARRAY_SIZE(signal_edge_names))
 436                         return SR_ERR_BUG;
 437                 *data = g_variant_new_string(signal_edge_names[0]);
 438                 break;
 439         default:
 440                 return SR_ERR_NA;
 441         }
 442
 443         return SR_OK;
 444 }
 445
 446 /*
 447  * Helper for mapping a string-typed configuration value to an index
 448  * within a table of possible values.
 449  */
 450 static int lookup_index(GVariant *value, const char *const *table, int len)
 451 {
 452         const char *entry;
 453         int i;
 454
 455         entry = g_variant_get_string(value, NULL);
 456         if (!entry)
 457                 return -1;
 458
 459         /* Linear search is fine for very small tables. */
 460         for (i = 0; i < len; i++) {
 461                 if (strcmp(entry, table[i]) == 0)
 462                         return i;
 463         }
 464
 465         return -1;
 466 }
 467
 468 static int config_set(uint32_t key, GVariant *data,
 469         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 470 {
 471         struct dev_context *devc;
 472         uint64_t arg;
 473         int i, ret;
 474         gdouble low, high;
 475
 476         (void)cg;
 477
 478         if (!sdi)
 479                 return SR_ERR_ARG;
 480
 481         devc = sdi->priv;
 482
 483         ret = SR_OK;
 484
 485         switch (key) {
 486         case SR_CONF_SAMPLERATE:
 487                 arg = g_variant_get_uint64(data);
 488                 for (i = 0; i < devc->num_samplerates; i++) {
 489                         if (devc->samplerates[i] == arg) {
 490                                 devc->cur_samplerate = arg;
 491                                 break;
 492                         }
 493                 }
 494                 if (i == devc->num_samplerates)
 495                         ret = SR_ERR_ARG;
 496                 break;
 497         case SR_CONF_LIMIT_SAMPLES:
 498                 devc->limit_samples = g_variant_get_uint64(data);
 499                 break;
 500         case SR_CONF_CAPTURE_RATIO:
 501                 devc->capture_ratio = g_variant_get_uint64(data);
 502                 ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
 503                 break;
 504         case SR_CONF_VOLTAGE_THRESHOLD:
 505                 g_variant_get(data, "(dd)", &low, &high);
 506                 if (!strcmp(devc->profile->model, "DSLogic")) {
 507                         for (i = 0; (unsigned int)i < ARRAY_SIZE(voltage_thresholds); i++) {
 508                                 if (fabs(voltage_thresholds[i][0] - low) < 0.1 &&
 509                                     fabs(voltage_thresholds[i][1] - high) < 0.1) {
 510                                         devc->cur_threshold =
 511                                                 voltage_thresholds[i][0];
 512                                         break;
 513                                 }
 514                         }
 515                         ret = dslogic_fpga_firmware_upload(sdi);
 516                 } else {
 517                         ret = dslogic_set_voltage_threshold(sdi, (low + high) / 2.0);
 518                 }
 519                 break;
 520         case SR_CONF_EXTERNAL_CLOCK:
 521                 devc->external_clock = g_variant_get_boolean(data);
 522                 break;
 523         case SR_CONF_CONTINUOUS:
 524                 devc->continuous_mode = g_variant_get_boolean(data);
 525                 break;
 526         case SR_CONF_CLOCK_EDGE:
 527                 i = lookup_index(data, ARRAY_AND_SIZE(signal_edge_names));
 528                 if (i < 0)
 529                         return SR_ERR_ARG;
 530                 devc->clock_edge = i;
 531                 break;
 532         default:
 533                 ret = SR_ERR_NA;
 534         }
 535
 536         return ret;
 537 }
 538
 539 static int config_list(uint32_t key, GVariant **data,
 540         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 541 {
 542         struct dev_context *devc;
 543
 544         devc = (sdi) ? sdi->priv : NULL;
 545
 546         switch (key) {
 547         case SR_CONF_SCAN_OPTIONS:
 548         case SR_CONF_DEVICE_OPTIONS:
 549                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 550         case SR_CONF_VOLTAGE_THRESHOLD:
 551                 if (!strcmp(devc->profile->model, "DSLogic"))
 552                         *data = std_gvar_thresholds(ARRAY_AND_SIZE(voltage_thresholds));
 553                 else
 554                         *data = std_gvar_min_max_step_thresholds(0.0, 5.0, 0.1);
 555                 break;
 556         case SR_CONF_SAMPLERATE:
 557                 *data = std_gvar_samplerates(devc->samplerates, devc->num_samplerates);
 558                 break;
 559         case SR_CONF_CLOCK_EDGE:
 560                 *data = g_variant_new_strv(ARRAY_AND_SIZE(signal_edge_names));
 561                 break;
 562         default:
 563                 return SR_ERR_NA;
 564         }
 565
 566         return SR_OK;
 567 }
 568
 569 static struct sr_dev_driver dreamsourcelab_dslogic_driver_info = {
 570         .name = "dreamsourcelab-dslogic",
 571         .longname = "DreamSourceLab DSLogic",
 572         .api_version = 1,
 573         .init = std_init,
 574         .cleanup = std_cleanup,
 575         .scan = scan,
 576         .dev_list = std_dev_list,
 577         .dev_clear = std_dev_clear,
 578         .config_get = config_get,
 579         .config_set = config_set,
 580         .config_list = config_list,
 581         .dev_open = dev_open,
 582         .dev_close = dev_close,
 583         .dev_acquisition_start = dslogic_acquisition_start,
 584         .dev_acquisition_stop = dslogic_acquisition_stop,
 585         .context = NULL,
 586 };
 587 SR_REGISTER_DEV_DRIVER(dreamsourcelab_dslogic_driver_info);