hardware/fx2lafw/fx2lafw.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 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 <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <inttypes.h>
  25 #include <libusb.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28 #include "fx2lafw.h"
  29 #include "command.h"
  30
  31 static const struct fx2lafw_profile supported_fx2[] = {
  32         /*
  33          * CWAV USBee AX
  34          * EE Electronics ESLA201A
  35          * ARMFLY AX-Pro
  36          */
  37         { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
  38                 FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
  39                 0 },
  40         /*
  41          * CWAV USBee DX
  42          * XZL-Studio DX
  43          */
  44         { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
  45                 FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
  46                 DEV_CAPS_16BIT },
  47
  48         /*
  49          * CWAV USBee SX
  50          */
  51         { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
  52                 FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
  53                 0 },
  54
  55         /*
  56          * Saleae Logic
  57          * EE Electronics ESLA100
  58          * Robomotic MiniLogic
  59          * Robomotic BugLogic 3
  60          */
  61         { 0x0925, 0x3881, "Saleae", "Logic", NULL,
  62                 FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
  63                 0 },
  64
  65         /*
  66          * Default Cypress FX2 without EEPROM, e.g.:
  67          * Lcsoft Mini Board
  68          * Braintechnology USB Interface V2.x
  69          */
  70         { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
  71                 FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
  72                 DEV_CAPS_16BIT },
  73
  74         /*
  75          * Braintechnology USB-LPS
  76          */
  77         { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
  78                 FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
  79                 DEV_CAPS_16BIT },
  80
  81         { 0, 0, 0, 0, 0, 0, 0 }
  82 };
  83
  84 static const int hwcaps[] = {
  85         SR_HWCAP_LOGIC_ANALYZER,
  86         SR_HWCAP_SAMPLERATE,
  87
  88         /* These are really implemented in the driver, not the hardware. */
  89         SR_HWCAP_LIMIT_SAMPLES,
  90         SR_HWCAP_CONTINUOUS,
  91         0,
  92 };
  93
  94 static const char *probe_names[] = {
  95         "0",  "1",  "2",  "3",  "4",  "5",  "6",  "7",
  96         "8",  "9", "10", "11", "12", "13", "14", "15",
  97         NULL,
  98 };
  99
 100 static const uint64_t supported_samplerates[] = {
 101         SR_KHZ(20),
 102         SR_KHZ(25),
 103         SR_KHZ(50),
 104         SR_KHZ(100),
 105         SR_KHZ(200),
 106         SR_KHZ(250),
 107         SR_KHZ(500),
 108         SR_MHZ(1),
 109         SR_MHZ(2),
 110         SR_MHZ(3),
 111         SR_MHZ(4),
 112         SR_MHZ(6),
 113         SR_MHZ(8),
 114         SR_MHZ(12),
 115         SR_MHZ(16),
 116         SR_MHZ(24),
 117         0,
 118 };
 119
 120 static const struct sr_samplerates samplerates = {
 121         0,
 122         0,
 123         0,
 124         supported_samplerates,
 125 };
 126
 127 SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 128 static struct sr_dev_driver *di = &fx2lafw_driver_info;
 129 static int hw_dev_close(struct sr_dev_inst *sdi);
 130 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 131                 const void *value);
 132 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 133
 134 /**
 135  * Check the USB configuration to determine if this is an fx2lafw device.
 136  *
 137  * @return TRUE if the device's configuration profile match fx2lafw
 138  *         configuration, FALSE otherwise.
 139  */
 140 static gboolean check_conf_profile(libusb_device *dev)
 141 {
 142         struct libusb_device_descriptor des;
 143         struct libusb_device_handle *hdl;
 144         gboolean ret;
 145         unsigned char strdesc[64];
 146
 147         hdl = NULL;
 148         ret = FALSE;
 149         while (!ret) {
 150                 /* Assume the FW has not been loaded, unless proven wrong. */
 151                 if (libusb_get_device_descriptor(dev, &des) != 0)
 152                         break;
 153
 154                 if (libusb_open(dev, &hdl) != 0)
 155                         break;
 156
 157                 if (libusb_get_string_descriptor_ascii(hdl,
 158                     des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
 159                         break;
 160                 if (strncmp((const char *)strdesc, "sigrok", 6))
 161                         break;
 162
 163                 if (libusb_get_string_descriptor_ascii(hdl,
 164                                 des.iProduct, strdesc, sizeof(strdesc)) < 0)
 165                         break;
 166                 if (strncmp((const char *)strdesc, "fx2lafw", 7))
 167                         break;
 168
 169                 /* If we made it here, it must be an fx2lafw. */
 170                 ret = TRUE;
 171         }
 172         if (hdl)
 173                 libusb_close(hdl);
 174
 175         return ret;
 176 }
 177
 178 static int fx2lafw_dev_open(struct sr_dev_inst *sdi)
 179 {
 180         libusb_device **devlist;
 181         struct libusb_device_descriptor des;
 182         struct dev_context *devc;
 183         struct drv_context *drvc;
 184         struct version_info vi;
 185         int ret, skip, i, device_count;
 186         uint8_t revid;
 187
 188         drvc = di->priv;
 189         devc = sdi->priv;
 190
 191         if (sdi->status == SR_ST_ACTIVE)
 192                 /* Device is already in use. */
 193                 return SR_ERR;
 194
 195         skip = 0;
 196         device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 197         if (device_count < 0) {
 198                 sr_err("Failed to get device list: %s.",
 199                        libusb_error_name(device_count));
 200                 return SR_ERR;
 201         }
 202
 203         for (i = 0; i < device_count; i++) {
 204                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
 205                         sr_err("Failed to get device descriptor: %s.",
 206                                libusb_error_name(ret));
 207                         continue;
 208                 }
 209
 210                 if (des.idVendor != devc->profile->vid
 211                     || des.idProduct != devc->profile->pid)
 212                         continue;
 213
 214                 if (sdi->status == SR_ST_INITIALIZING) {
 215                         if (skip != sdi->index) {
 216                                 /* Skip devices of this type that aren't the one we want. */
 217                                 skip += 1;
 218                                 continue;
 219                         }
 220                 } else if (sdi->status == SR_ST_INACTIVE) {
 221                         /*
 222                          * This device is fully enumerated, so we need to find
 223                          * this device by vendor, product, bus and address.
 224                          */
 225                         if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
 226                                 || libusb_get_device_address(devlist[i]) != devc->usb->address)
 227                                 /* This is not the one. */
 228                                 continue;
 229                 }
 230
 231                 if (!(ret = libusb_open(devlist[i], &devc->usb->devhdl))) {
 232                         if (devc->usb->address == 0xff)
 233                                 /*
 234                                  * First time we touch this device after FW
 235                                  * upload, so we don't know the address yet.
 236                                  */
 237                                 devc->usb->address = libusb_get_device_address(devlist[i]);
 238                 } else {
 239                         sr_err("Failed to open device: %s.",
 240                                libusb_error_name(ret));
 241                         break;
 242                 }
 243
 244                 ret = command_get_fw_version(devc->usb->devhdl, &vi);
 245                 if (ret != SR_OK) {
 246                         sr_err("Failed to get firmware version.");
 247                         break;
 248                 }
 249
 250                 ret = command_get_revid_version(devc->usb->devhdl, &revid);
 251                 if (ret != SR_OK) {
 252                         sr_err("Failed to get REVID.");
 253                         break;
 254                 }
 255
 256                 /*
 257                  * Changes in major version mean incompatible/API changes, so
 258                  * bail out if we encounter an incompatible version.
 259                  * Different minor versions are OK, they should be compatible.
 260                  */
 261                 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
 262                         sr_err("Expected firmware version %d.x, "
 263                                "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
 264                                vi.major, vi.minor);
 265                         break;
 266                 }
 267
 268                 sdi->status = SR_ST_ACTIVE;
 269                 sr_info("Opened device %d on %d.%d, "
 270                         "interface %d, firmware %d.%d.",
 271                         sdi->index, devc->usb->bus, devc->usb->address,
 272                         USB_INTERFACE, vi.major, vi.minor);
 273
 274                 sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
 275                         revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
 276
 277                 break;
 278         }
 279         libusb_free_device_list(devlist, 1);
 280
 281         if (sdi->status != SR_ST_ACTIVE)
 282                 return SR_ERR;
 283
 284         return SR_OK;
 285 }
 286
 287 static int configure_probes(const struct sr_dev_inst *sdi)
 288 {
 289         struct dev_context *devc;
 290         struct sr_probe *probe;
 291         GSList *l;
 292         int probe_bit, stage, i;
 293         char *tc;
 294
 295         devc = sdi->priv;
 296         for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
 297                 devc->trigger_mask[i] = 0;
 298                 devc->trigger_value[i] = 0;
 299         }
 300
 301         stage = -1;
 302         for (l = sdi->probes; l; l = l->next) {
 303                 probe = (struct sr_probe *)l->data;
 304                 if (probe->enabled == FALSE)
 305                         continue;
 306
 307                 if (probe->index > 7)
 308                         devc->sample_wide = TRUE;
 309
 310                 probe_bit = 1 << (probe->index);
 311                 if (!(probe->trigger))
 312                         continue;
 313
 314                 stage = 0;
 315                 for (tc = probe->trigger; *tc; tc++) {
 316                         devc->trigger_mask[stage] |= probe_bit;
 317                         if (*tc == '1')
 318                                 devc->trigger_value[stage] |= probe_bit;
 319                         stage++;
 320                         if (stage > NUM_TRIGGER_STAGES)
 321                                 return SR_ERR;
 322                 }
 323         }
 324
 325         if (stage == -1)
 326                 /*
 327                  * We didn't configure any triggers, make sure acquisition
 328                  * doesn't wait for any.
 329                  */
 330                 devc->trigger_stage = TRIGGER_FIRED;
 331         else
 332                 devc->trigger_stage = 0;
 333
 334         return SR_OK;
 335 }
 336
 337 static struct dev_context *fx2lafw_dev_new(void)
 338 {
 339         struct dev_context *devc;
 340
 341         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 342                 sr_err("Device context malloc failed.");
 343                 return NULL;
 344         }
 345
 346         devc->trigger_stage = TRIGGER_FIRED;
 347
 348         return devc;
 349 }
 350
 351 static int clear_instances(void)
 352 {
 353         GSList *l;
 354         struct sr_dev_inst *sdi;
 355         struct drv_context *drvc;
 356         struct dev_context *devc;
 357         int ret;
 358
 359         drvc = di->priv;
 360         ret = SR_OK;
 361         for (l = drvc->instances; l; l = l->next) {
 362                 if (!(sdi = l->data)) {
 363                         /* Log error, but continue cleaning up the rest. */
 364                         sr_err("sdi was NULL, continuing.");
 365                         ret = SR_ERR_BUG;
 366                         continue;
 367                 }
 368                 if (!(devc = sdi->priv)) {
 369                         /* Log error, but continue cleaning up the rest. */
 370                         sr_err("sdi->priv was NULL, continuing.");
 371                         ret = SR_ERR_BUG;
 372                         continue;
 373                 }
 374                 hw_dev_close(sdi);
 375                 sr_usb_dev_inst_free(devc->usb);
 376                 sdi = l->data;
 377                 sr_dev_inst_free(sdi);
 378         }
 379
 380         g_slist_free(drvc->instances);
 381         drvc->instances = NULL;
 382
 383         return ret;
 384 }
 385
 386 static int hw_init(struct sr_context *sr_ctx)
 387 {
 388         struct drv_context *drvc;
 389
 390         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
 391                 sr_err("Driver context malloc failed.");
 392                 return SR_ERR_MALLOC;
 393         }
 394
 395         drvc->sr_ctx = sr_ctx;
 396         di->priv = drvc;
 397
 398         return SR_OK;
 399 }
 400
 401 static GSList *hw_scan(GSList *options)
 402 {
 403         GSList *devices;
 404         struct libusb_device_descriptor des;
 405         struct sr_dev_inst *sdi;
 406         const struct fx2lafw_profile *prof;
 407         struct drv_context *drvc;
 408         struct dev_context *devc;
 409         struct sr_probe *probe;
 410         libusb_device **devlist;
 411         int devcnt, num_logic_probes, ret, i, j;
 412
 413         (void)options;
 414
 415         drvc = di->priv;
 416
 417         /* This scan always invalidates any previous scans. */
 418         clear_instances();
 419
 420         /* Find all fx2lafw compatible devices and upload firmware to them. */
 421         devices = NULL;
 422         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 423         for (i = 0; devlist[i]; i++) {
 424
 425                 if ((ret = libusb_get_device_descriptor(
 426                      devlist[i], &des)) != 0) {
 427                         sr_warn("Failed to get device descriptor: %s.",
 428                                 libusb_error_name(ret));
 429                         continue;
 430                 }
 431
 432                 prof = NULL;
 433                 for (j = 0; supported_fx2[j].vid; j++) {
 434                         if (des.idVendor == supported_fx2[j].vid &&
 435                                 des.idProduct == supported_fx2[j].pid) {
 436                                 prof = &supported_fx2[j];
 437                         }
 438                 }
 439
 440                 /* Skip if the device was not found. */
 441                 if (!prof)
 442                         continue;
 443
 444                 devcnt = g_slist_length(drvc->instances);
 445                 sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
 446                         prof->vendor, prof->model, prof->model_version);
 447                 if (!sdi)
 448                         return NULL;
 449                 sdi->driver = di;
 450
 451                 /* Fill in probelist according to this device's profile. */
 452                 num_logic_probes = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
 453                 for (j = 0; j < num_logic_probes; j++) {
 454                         if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
 455                                         probe_names[j])))
 456                                 return NULL;
 457                         sdi->probes = g_slist_append(sdi->probes, probe);
 458                 }
 459
 460                 devc = fx2lafw_dev_new();
 461                 devc->profile = prof;
 462                 sdi->priv = devc;
 463                 drvc->instances = g_slist_append(drvc->instances, sdi);
 464                 devices = g_slist_append(devices, sdi);
 465
 466                 if (check_conf_profile(devlist[i])) {
 467                         /* Already has the firmware, so fix the new address. */
 468                         sr_dbg("Found an fx2lafw device.");
 469                         sdi->status = SR_ST_INACTIVE;
 470                         devc->usb = sr_usb_dev_inst_new
 471                             (libusb_get_bus_number(devlist[i]),
 472                              libusb_get_device_address(devlist[i]), NULL);
 473                 } else {
 474                         if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
 475                                 prof->firmware) == SR_OK)
 476                                 /* Store when this device's FW was updated. */
 477                                 devc->fw_updated = g_get_monotonic_time();
 478                         else
 479                                 sr_err("Firmware upload failed for "
 480                                        "device %d.", devcnt);
 481                         devc->usb = sr_usb_dev_inst_new
 482                                 (libusb_get_bus_number(devlist[i]), 0xff, NULL);
 483                 }
 484         }
 485         libusb_free_device_list(devlist, 1);
 486
 487         return devices;
 488 }
 489
 490 static GSList *hw_dev_list(void)
 491 {
 492         struct drv_context *drvc;
 493
 494         drvc = di->priv;
 495
 496         return drvc->instances;
 497 }
 498
 499 static int hw_dev_open(struct sr_dev_inst *sdi)
 500 {
 501         struct dev_context *devc;
 502         int ret;
 503         int64_t timediff_us, timediff_ms;
 504
 505         devc = sdi->priv;
 506
 507         /*
 508          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
 509          * milliseconds for the FX2 to renumerate.
 510          */
 511         ret = SR_ERR;
 512         if (devc->fw_updated > 0) {
 513                 sr_info("Waiting for device to reset.");
 514                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
 515                 g_usleep(300 * 1000);
 516                 timediff_ms = 0;
 517                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
 518                         if ((ret = fx2lafw_dev_open(sdi)) == SR_OK)
 519                                 break;
 520                         g_usleep(100 * 1000);
 521
 522                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
 523                         timediff_ms = timediff_us / 1000;
 524                         sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
 525                 }
 526                 if (ret != SR_OK) {
 527                         sr_err("Device failed to renumerate.");
 528                         return SR_ERR;
 529                 }
 530                 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
 531         } else {
 532                 sr_info("Firmware upload was not needed.");
 533                 ret = fx2lafw_dev_open(sdi);
 534         }
 535
 536         if (ret != SR_OK) {
 537                 sr_err("Unable to open device.");
 538                 return SR_ERR;
 539         }
 540
 541         devc = sdi->priv;
 542
 543         ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
 544         if (ret != 0) {
 545                 switch(ret) {
 546                 case LIBUSB_ERROR_BUSY:
 547                         sr_err("Unable to claim USB interface. Another "
 548                                "program or driver has already claimed it.");
 549                         break;
 550                 case LIBUSB_ERROR_NO_DEVICE:
 551                         sr_err("Device has been disconnected.");
 552                         break;
 553                 default:
 554                         sr_err("Unable to claim interface: %s.",
 555                                libusb_error_name(ret));
 556                         break;
 557                 }
 558
 559                 return SR_ERR;
 560         }
 561
 562         if (devc->cur_samplerate == 0) {
 563                 /* Samplerate hasn't been set; default to the slowest one. */
 564                 if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
 565                     &supported_samplerates[0]) == SR_ERR)
 566                         return SR_ERR;
 567         }
 568
 569         return SR_OK;
 570 }
 571
 572 static int hw_dev_close(struct sr_dev_inst *sdi)
 573 {
 574         struct dev_context *devc;
 575
 576         devc = sdi->priv;
 577         if (devc->usb->devhdl == NULL)
 578                 return SR_ERR;
 579
 580         sr_info("Closing device %d on %d.%d, interface %d.",
 581                 sdi->index, devc->usb->bus, devc->usb->address, USB_INTERFACE);
 582         libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
 583         libusb_close(devc->usb->devhdl);
 584         devc->usb->devhdl = NULL;
 585         sdi->status = SR_ST_INACTIVE;
 586
 587         return SR_OK;
 588 }
 589
 590 static int hw_cleanup(void)
 591 {
 592         struct drv_context *drvc;
 593         int ret;
 594
 595         if (!(drvc = di->priv))
 596                 return SR_OK;
 597
 598         ret = clear_instances();
 599
 600         g_free(drvc);
 601         di->priv = NULL;
 602
 603         return ret;
 604 }
 605
 606 static int hw_info_get(int info_id, const void **data,
 607                 const struct sr_dev_inst *sdi)
 608 {
 609         struct dev_context *devc;
 610
 611         switch (info_id) {
 612         case SR_DI_HWCAPS:
 613                 *data = hwcaps;
 614                 break;
 615         case SR_DI_SAMPLERATES:
 616                 *data = &samplerates;
 617                 break;
 618         case SR_DI_TRIGGER_TYPES:
 619                 *data = TRIGGER_TYPES;
 620                 break;
 621         case SR_DI_CUR_SAMPLERATE:
 622                 if (sdi) {
 623                         devc = sdi->priv;
 624                         *data = &devc->cur_samplerate;
 625                 } else
 626                         return SR_ERR;
 627                 break;
 628         default:
 629                 return SR_ERR_ARG;
 630         }
 631
 632         return SR_OK;
 633 }
 634
 635 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 636                 const void *value)
 637 {
 638         struct dev_context *devc;
 639         int ret;
 640
 641         devc = sdi->priv;
 642
 643         if (hwcap == SR_HWCAP_SAMPLERATE) {
 644                 devc->cur_samplerate = *(const uint64_t *)value;
 645                 ret = SR_OK;
 646         } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
 647                 devc->limit_samples = *(const uint64_t *)value;
 648                 ret = SR_OK;
 649         } else {
 650                 ret = SR_ERR;
 651         }
 652
 653         return ret;
 654 }
 655
 656 static int receive_data(int fd, int revents, void *cb_data)
 657 {
 658         struct timeval tv;
 659         struct drv_context *drvc;
 660
 661         (void)fd;
 662         (void)revents;
 663         (void)cb_data;
 664
 665         drvc = di->priv;
 666
 667         tv.tv_sec = tv.tv_usec = 0;
 668         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 669
 670         return TRUE;
 671 }
 672
 673 static void abort_acquisition(struct dev_context *devc)
 674 {
 675         int i;
 676
 677         devc->num_samples = -1;
 678
 679         for (i = devc->num_transfers - 1; i >= 0; i--) {
 680                 if (devc->transfers[i])
 681                         libusb_cancel_transfer(devc->transfers[i]);
 682         }
 683 }
 684
 685 static void finish_acquisition(struct dev_context *devc)
 686 {
 687         struct sr_datafeed_packet packet;
 688         struct drv_context *drvc = di->priv;
 689         const struct libusb_pollfd **lupfd;
 690         int i;
 691
 692         /* Terminate session. */
 693         packet.type = SR_DF_END;
 694         sr_session_send(devc->session_dev_id, &packet);
 695
 696         /* Remove fds from polling. */
 697         lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 698         for (i = 0; lupfd[i]; i++)
 699                 sr_source_remove(lupfd[i]->fd);
 700         free(lupfd); /* NOT g_free()! */
 701
 702         devc->num_transfers = 0;
 703         g_free(devc->transfers);
 704 }
 705
 706 static void free_transfer(struct libusb_transfer *transfer)
 707 {
 708         struct dev_context *devc;
 709         unsigned int i;
 710
 711         devc = transfer->user_data;
 712
 713         g_free(transfer->buffer);
 714         transfer->buffer = NULL;
 715         libusb_free_transfer(transfer);
 716
 717         for (i = 0; i < devc->num_transfers; i++) {
 718                 if (devc->transfers[i] == transfer) {
 719                         devc->transfers[i] = NULL;
 720                         break;
 721                 }
 722         }
 723
 724         devc->submitted_transfers--;
 725         if (devc->submitted_transfers == 0)
 726                 finish_acquisition(devc);
 727 }
 728
 729 static void resubmit_transfer(struct libusb_transfer *transfer)
 730 {
 731         int ret;
 732
 733         if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
 734                 return;
 735
 736         free_transfer(transfer);
 737         /* TODO: Stop session? */
 738
 739         sr_err("%s: %s", __func__, libusb_error_name(ret));
 740 }
 741
 742 static void receive_transfer(struct libusb_transfer *transfer)
 743 {
 744         gboolean packet_has_error = FALSE;
 745         struct sr_datafeed_packet packet;
 746         struct sr_datafeed_logic logic;
 747         struct dev_context *devc;
 748         int trigger_offset, i, sample_width, cur_sample_count;
 749         int trigger_offset_bytes;
 750         uint8_t *cur_buf;
 751
 752         devc = transfer->user_data;
 753
 754         /*
 755          * If acquisition has already ended, just free any queued up
 756          * transfer that come in.
 757          */
 758         if (devc->num_samples == -1) {
 759                 free_transfer(transfer);
 760                 return;
 761         }
 762
 763         sr_info("receive_transfer(): status %d received %d bytes.",
 764                 transfer->status, transfer->actual_length);
 765
 766         /* Save incoming transfer before reusing the transfer struct. */
 767         cur_buf = transfer->buffer;
 768         sample_width = devc->sample_wide ? 2 : 1;
 769         cur_sample_count = transfer->actual_length / sample_width;
 770
 771         switch (transfer->status) {
 772         case LIBUSB_TRANSFER_NO_DEVICE:
 773                 abort_acquisition(devc);
 774                 free_transfer(transfer);
 775                 return;
 776         case LIBUSB_TRANSFER_COMPLETED:
 777         case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
 778                 break;
 779         default:
 780                 packet_has_error = TRUE;
 781                 break;
 782         }
 783
 784         if (transfer->actual_length == 0 || packet_has_error) {
 785                 devc->empty_transfer_count++;
 786                 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
 787                         /*
 788                          * The FX2 gave up. End the acquisition, the frontend
 789                          * will work out that the samplecount is short.
 790                          */
 791                         abort_acquisition(devc);
 792                         free_transfer(transfer);
 793                 } else {
 794                         resubmit_transfer(transfer);
 795                 }
 796                 return;
 797         } else {
 798                 devc->empty_transfer_count = 0;
 799         }
 800
 801         trigger_offset = 0;
 802         if (devc->trigger_stage >= 0) {
 803                 for (i = 0; i < cur_sample_count; i++) {
 804
 805                         const uint16_t cur_sample = devc->sample_wide ?
 806                                 *((const uint16_t*)cur_buf + i) :
 807                                 *((const uint8_t*)cur_buf + i);
 808
 809                         if ((cur_sample & devc->trigger_mask[devc->trigger_stage]) ==
 810                                 devc->trigger_value[devc->trigger_stage]) {
 811                                 /* Match on this trigger stage. */
 812                                 devc->trigger_buffer[devc->trigger_stage] = cur_sample;
 813                                 devc->trigger_stage++;
 814
 815                                 if (devc->trigger_stage == NUM_TRIGGER_STAGES ||
 816                                         devc->trigger_mask[devc->trigger_stage] == 0) {
 817                                         /* Match on all trigger stages, we're done. */
 818                                         trigger_offset = i + 1;
 819
 820                                         /*
 821                                          * TODO: Send pre-trigger buffer to session bus.
 822                                          * Tell the frontend we hit the trigger here.
 823                                          */
 824                                         packet.type = SR_DF_TRIGGER;
 825                                         packet.payload = NULL;
 826                                         sr_session_send(devc->session_dev_id, &packet);
 827
 828                                         /*
 829                                          * Send the samples that triggered it,
 830                                          * since we're skipping past them.
 831                                          */
 832                                         packet.type = SR_DF_LOGIC;
 833                                         packet.payload = &logic;
 834                                         logic.unitsize = sizeof(*devc->trigger_buffer);
 835                                         logic.length = devc->trigger_stage * logic.unitsize;
 836                                         logic.data = devc->trigger_buffer;
 837                                         sr_session_send(devc->session_dev_id, &packet);
 838
 839                                         devc->trigger_stage = TRIGGER_FIRED;
 840                                         break;
 841                                 }
 842                         } else if (devc->trigger_stage > 0) {
 843                                 /*
 844                                  * We had a match before, but not in the next sample. However, we may
 845                                  * have a match on this stage in the next bit -- trigger on 0001 will
 846                                  * fail on seeing 00001, so we need to go back to stage 0 -- but at
 847                                  * the next sample from the one that matched originally, which the
 848                                  * counter increment at the end of the loop takes care of.
 849                                  */
 850                                 i -= devc->trigger_stage;
 851                                 if (i < -1)
 852                                         i = -1; /* Oops, went back past this buffer. */
 853                                 /* Reset trigger stage. */
 854                                 devc->trigger_stage = 0;
 855                         }
 856                 }
 857         }
 858
 859         if (devc->trigger_stage == TRIGGER_FIRED) {
 860                 /* Send the incoming transfer to the session bus. */
 861                 trigger_offset_bytes = trigger_offset * sample_width;
 862                 packet.type = SR_DF_LOGIC;
 863                 packet.payload = &logic;
 864                 logic.length = transfer->actual_length - trigger_offset_bytes;
 865                 logic.unitsize = sample_width;
 866                 logic.data = cur_buf + trigger_offset_bytes;
 867                 sr_session_send(devc->session_dev_id, &packet);
 868
 869                 devc->num_samples += cur_sample_count;
 870                 if (devc->limit_samples &&
 871                         (unsigned int)devc->num_samples > devc->limit_samples) {
 872                         abort_acquisition(devc);
 873                         free_transfer(transfer);
 874                         return;
 875                 }
 876         } else {
 877                 /*
 878                  * TODO: Buffer pre-trigger data in capture
 879                  * ratio-sized buffer.
 880                  */
 881         }
 882
 883         resubmit_transfer(transfer);
 884 }
 885
 886 static unsigned int to_bytes_per_ms(unsigned int samplerate)
 887 {
 888         return samplerate / 1000;
 889 }
 890
 891 static size_t get_buffer_size(struct dev_context *devc)
 892 {
 893         size_t s;
 894
 895         /*
 896          * The buffer should be large enough to hold 10ms of data and
 897          * a multiple of 512.
 898          */
 899         s = 10 * to_bytes_per_ms(devc->cur_samplerate);
 900         return (s + 511) & ~511;
 901 }
 902
 903 static unsigned int get_number_of_transfers(struct dev_context *devc)
 904 {
 905         unsigned int n;
 906
 907         /* Total buffer size should be able to hold about 500ms of data. */
 908         n = 500 * to_bytes_per_ms(devc->cur_samplerate) / get_buffer_size(devc);
 909
 910         if (n > NUM_SIMUL_TRANSFERS)
 911                 return NUM_SIMUL_TRANSFERS;
 912
 913         return n;
 914 }
 915
 916 static unsigned int get_timeout(struct dev_context *devc)
 917 {
 918         size_t total_size;
 919         unsigned int timeout;
 920
 921         total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
 922         timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
 923         return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
 924 }
 925
 926 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 927                 void *cb_data)
 928 {
 929         struct sr_datafeed_packet packet;
 930         struct sr_datafeed_header header;
 931         struct dev_context *devc;
 932         struct drv_context *drvc;
 933         struct libusb_transfer *transfer;
 934         const struct libusb_pollfd **lupfd;
 935         unsigned int i, timeout, num_transfers;
 936         int ret;
 937         unsigned char *buf;
 938         size_t size;
 939
 940         drvc = di->priv;
 941         devc = sdi->priv;
 942
 943         if (devc->submitted_transfers != 0)
 944                 return SR_ERR;
 945
 946         if (configure_probes(sdi) != SR_OK) {
 947                 sr_err("Failed to configure probes.");
 948                 return SR_ERR;
 949         }
 950
 951         devc->session_dev_id = cb_data;
 952         devc->num_samples = 0;
 953         devc->empty_transfer_count = 0;
 954
 955         timeout = get_timeout(devc);
 956         num_transfers = get_number_of_transfers(devc);
 957         size = get_buffer_size(devc);
 958
 959         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
 960         if (!devc->transfers) {
 961                 sr_err("USB transfers malloc failed.");
 962                 return SR_ERR_MALLOC;
 963         }
 964
 965         devc->num_transfers = num_transfers;
 966
 967         for (i = 0; i < num_transfers; i++) {
 968                 if (!(buf = g_try_malloc(size))) {
 969                         sr_err("USB transfer buffer malloc failed.");
 970                         return SR_ERR_MALLOC;
 971                 }
 972                 transfer = libusb_alloc_transfer(0);
 973                 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
 974                                 2 | LIBUSB_ENDPOINT_IN, buf, size,
 975                                 receive_transfer, devc, timeout);
 976                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
 977                         sr_err("Failed to submit transfer: %s.",
 978                                libusb_error_name(ret));
 979                         libusb_free_transfer(transfer);
 980                         g_free(buf);
 981                         abort_acquisition(devc);
 982                         return SR_ERR;
 983                 }
 984                 devc->transfers[i] = transfer;
 985                 devc->submitted_transfers++;
 986         }
 987
 988         lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 989         for (i = 0; lupfd[i]; i++)
 990                 sr_source_add(lupfd[i]->fd, lupfd[i]->events,
 991                               timeout, receive_data, NULL);
 992         free(lupfd); /* NOT g_free()! */
 993
 994         packet.type = SR_DF_HEADER;
 995         packet.payload = &header;
 996         header.feed_version = 1;
 997         gettimeofday(&header.starttime, NULL);
 998         sr_session_send(cb_data, &packet);
 999
1000         if ((ret = command_start_acquisition(devc->usb->devhdl,
1001                 devc->cur_samplerate, devc->sample_wide)) != SR_OK) {
1002                 abort_acquisition(devc);
1003                 return ret;
1004         }
1005
1006         return SR_OK;
1007 }
1008
1009 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
1010 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
1011 {
1012         (void)cb_data;
1013
1014         abort_acquisition(sdi->priv);
1015
1016         return SR_OK;
1017 }
1018
1019 SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
1020         .name = "fx2lafw",
1021         .longname = "fx2lafw (generic driver for FX2 based LAs)",
1022         .api_version = 1,
1023         .init = hw_init,
1024         .cleanup = hw_cleanup,
1025         .scan = hw_scan,
1026         .dev_list = hw_dev_list,
1027         .dev_clear = clear_instances,
1028         .dev_open = hw_dev_open,
1029         .dev_close = hw_dev_close,
1030         .info_get = hw_info_get,
1031         .dev_config_set = hw_dev_config_set,
1032         .dev_acquisition_start = hw_dev_acquisition_start,
1033         .dev_acquisition_stop = hw_dev_acquisition_stop,
1034         .priv = NULL,
1035 };