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