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