hardware/fx2lafw/fx2lafw.c

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