hardware/fx2lafw/fx2lafw.c

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