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