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